Packagecom.whirled.net
Interfacepublic interface PropertyGetSubControl extends flash.events.IEventDispatcher
SubinterfacesPropertySubControl

Provides the ability to read game state in the form of named properties which are automatically shared between players and, potentially, the server agent.



Public Methods
 MethodDefined by
  
get(propName:String):Object
Get a property value.
PropertyGetSubControl
  
getPropertyNames(prefix:String = ""):Array
Get the names of all currently-set properties that begin with the specified prefix.
PropertyGetSubControl
  
Get the targetId on which this control operates.
PropertyGetSubControl
Events
 EventSummaryDefined by
   Dispatched when an element inside a property has changed in the shared game state.PropertyGetSubControl
   Dispatched when a property has changed in the shared game state.PropertyGetSubControl
Method detail
get()method
public function get(propName:String):Object

Get a property value. Calling this method results in no network traffic, it just examines values that have already arrived over the network to this client.

Parameters
propName:String — the name of the property to retrieve.

Returns
Object — the property value, or null if there is no property with that name.
getPropertyNames()method 
public function getPropertyNames(prefix:String = ""):Array

Get the names of all currently-set properties that begin with the specified prefix. Calling this method results in no network traffic.

Parameters
prefix:String (default = "")

Returns
Array
getTargetId()method 
public function getTargetId():int

Get the targetId on which this control operates.

Returns
int
Event detail
ElemChangedevent 
Event object type: com.whirled.net.ElementChangedEvent

Dispatched when an element inside a property has changed in the shared game state. This event is a result of calling setIn() or setAt().

PropChangedevent  
Event object type: com.whirled.net.PropertyChangedEvent

Dispatched when a property has changed in the shared game state. This event is a result of calling set() or testAndSet().