Packagecom.whirled.avrg
Classpublic class AVRGameRoomEvent
InheritanceAVRGameRoomEvent Inheritance AVRGameControlEvent Inheritance flash.events.Event

Conveys information about a change to the state of a particular room in an AVR game.

See also

RoomSubControlClient
RoomSubControlServer


Public Properties
 PropertyDefined by
 Inheritedname : String
Retrieves the 'name' for this event, which is a String value whose meaning is determined by the event type.
AVRGameControlEvent
  roomId : int
[read-only] Gets the id of the room whose state is changing.
AVRGameRoomEvent
 Inheritedvalue : Object
Retrieves the object 'value' for this event, which is a value whose meaning is determined by the event type.
AVRGameControlEvent
Public Methods
 MethodDefined by
  
AVRGameRoomEvent(type:String, roomId:int, name:String = null, value:Object = null)
Creates a new AVRGameRoomEvent.
AVRGameRoomEvent
  
clone():Event
AVRGameRoomEvent
  
toString():String
AVRGameRoomEvent
Public Constants
 ConstantDefined by
  AVATAR_CHANGED : String = "avatarChanged"
[static] An event type dispatched when something has changed about an avatar in the room.
AVRGameRoomEvent
 InheritedMOB_APPEARANCE_CHANGED : String = "mobAppearanceChanged"
[static] An event type dispatched when a spawned MOB has changed appearance.
AVRGameControlEvent
  MOB_CONTROL_AVAILABLE : String = "mobControlAvailable"
[static] An event type dispatched when the control for a MOB spawned in the room has become available.
AVRGameRoomEvent
  PLAYER_ENTERED : String = "playerEntered"
[static] An event type dispatched when a player entered the room.
AVRGameRoomEvent
 InheritedPLAYER_JOINED_GAME : String = "playerJoinedGame"
[static] An event type dispatched when somebody joined the AVRG.
AVRGameControlEvent
  PLAYER_LEFT : String = "playerLeft"
[static] An event type dispatched either when a player leaves the room.
AVRGameRoomEvent
  PLAYER_MOVED : String = "playerMoved"
[static] An event type dispatched when a player of our game who's also in the room took up a new location.
AVRGameRoomEvent
 InheritedPLAYER_QUIT_GAME : String = "playerQuitGame"
[static] An event type dispatched when somebody is leaving the AVRG.
AVRGameControlEvent
  ROOM_UNLOADED : String = "roomUnloaded"
[static] Dispatched when a room has unloaded and is no longer accessible.
AVRGameRoomEvent
  SIGNAL_RECEIVED : String = "signalReceived"
[static] An event type dispatched when a signal has been received in this room.
AVRGameRoomEvent
 InheritedSIZE_CHANGED : String = "sizeChanged"
[static] An event type dispatched when the control has been resized.
AVRGameControlEvent
Property detail
roomIdproperty
roomId:int  [read-only]

Gets the id of the room whose state is changing.

Implementation
    public function get roomId():int
Constructor detail
AVRGameRoomEvent()constructor
public function AVRGameRoomEvent(type:String, roomId:int, name:String = null, value:Object = null)

Creates a new AVRGameRoomEvent.

Parameters
type:String
 
roomId:int
 
name:String (default = null)
 
value:Object (default = null)
Method detail
clone()method
public override function clone():Event

Returns
Event
toString()method 
public override function toString():String

Returns
String
Constant detail
AVATAR_CHANGEDconstant
public static const AVATAR_CHANGED:String = "avatarChanged"

An event type dispatched when something has changed about an avatar in the room.
name - not used
value :int - id of the player whose avatar changed

See also

MOB_CONTROL_AVAILABLEconstant 
public static const MOB_CONTROL_AVAILABLE:String = "mobControlAvailable"

An event type dispatched when the control for a MOB spawned in the room has become available.
name - the id of the MOB
value :MobSubControlBase - the new control

See also

PLAYER_ENTEREDconstant 
public static const PLAYER_ENTERED:String = "playerEntered"

An event type dispatched when a player entered the room.
name - not used
value :int - the id of the player entering

PLAYER_LEFTconstant 
public static const PLAYER_LEFT:String = "playerLeft"

An event type dispatched either when a player leaves the room.
name - not used
value :int - the id of the player leaving

PLAYER_MOVEDconstant 
public static const PLAYER_MOVED:String = "playerMoved"

An event type dispatched when a player of our game who's also in the room took up a new location.
name - not used
value :int - the id of the player who moved

ROOM_UNLOADEDconstant 
public static const ROOM_UNLOADED:String = "roomUnloaded"

Dispatched when a room has unloaded and is no longer accessible. Note that once this has happened, any further API methods called (except getRoomId()) will throw errors and no further events will be dispatched on it. The purpose of this event is for local cleanup, deregistration of event listeners, clearing out data structures and the like.

SIGNAL_RECEIVEDconstant 
public static const SIGNAL_RECEIVED:String = "signalReceived"

An event type dispatched when a signal has been received in this room.
name - The name of the signal.
value - The arg sent with the signal, or null.

See also