Declares all of the code objects available in the AVRG client and server api. Note that the
server functions declared here are proxies that will send a message to the server requesting
that it call the function and send a reply with the return value. The proxy functions are
auto generated and the real functions are defined in
ServerDefinitions.
protected var _client:Object
protected var _ctrl:AVRGameControl
protected var _makeDecoration:Function
protected var _server:Object
public function Definitions(ctrl:AVRGameControl, makeDecoration:Function)
Creates new definitions.
Parameters
| ctrl:AVRGameControl — the game control to use for our closures
|
| |
| makeDecoration:Function — the closure to use when creating a decoration
|
public function addListenerToAll(listener:Function):void
Add the given event listener function to all available event types and dispatchers.
Parameters
protected function createAgentFuncs():Array
Returns
protected function createGameFuncs():Array
Returns
protected function createLocalFuncs():Array
Returns
protected function createMobFuncs():Array
Returns
protected function createPartyFuncs():Array
Returns
protected function createPlayerFuncs():Array
Returns
protected function createRoomFuncs():Array
Returns
protected function createServerGameFuncs():Array
Returns
protected function createServerMiscFuncs():Array
Returns
protected function createServerMobFuncs():Array
Returns
protected function createServerPlayerFuncs():Array
Returns
protected function createServerRoomFuncs():Array
Returns
protected function enumEvents(functor:Function):voidParameters
public function getControls(server:Boolean):Array
Get the categories of functions available on the AVRG client.
Parameters
| server:Boolean — if set, return only server categories, otherwise only client categories
|
Returns
| Array — an array of strings, one per category of function
|
public function getFuncs(server:Boolean, ctrlName:String):Array
Get the functions for a given category.
Parameters
| server:Boolean |
| |
| ctrlName:String |
Returns
| Array — an Array of FunctionSpec instances.
|
protected function introspectControl(ctrl:Object):Object
TODO
My idea was: introspect and figure out all the controls and functions on each.
These would be lacking in nice parameter names, but then, where we have methods defined
that matched the actual definitions, we could drop in the nice names. Rabbit hole. Punting.
Parameters
Returns
protected function isFunctionSuppressed(name:String):Boolean
Would we like to suppress a function with the specified name from our autogenerated list
of functions?
Parameters
Returns
protected function proxy(prefix:String, name:String):FunctionParameters
| prefix:String |
| |
| name:String |
Returns
protected function pushPropsFuncs(funcs:Array, props:PropertyGetSubControl):voidParameters
| funcs:Array |
| |
| props:PropertyGetSubControl |
protected function pushPropsSetFuncs(funcs:Array, props:PropertySubControl):voidParameters
| funcs:Array |
| |
| props:PropertySubControl |
public function removeListenerFromAll(listener:Function):void
Removes the given event listener function from all available event types and dispatchers.
Parameters
public static const CLIENT_EVENTS:Array All events that may occur on LocalSubControl.
public static const GAME_EVENTS:Array All events that may occur on GameSubControlClient.
public static const NET_EVENTS:Array All events that may occur on a property space.
public static const PARTY_EVENTS:Array All events that may occur on PartySubControl.
public static const PLAYER_EVENTS:Array All events that may occur on PlayerSubControlClient.
public static const ROOM_EVENTS:Array All events that may occur on RoomSubControlClient.
