Package | com.whirled.net |
Class | public class MessageReceivedEvent |
Inheritance | MessageReceivedEvent ![]() |
Property | Defined by | ||
---|---|---|---|
name : String [read-only]
Access the message name.
| MessageReceivedEvent | ||
senderId : int [read-only]
Access the id of the occupant that sent the message.
| MessageReceivedEvent | ||
value : Object [read-only]
Access the message value.
| MessageReceivedEvent |
Method | Defined by | ||
---|---|---|---|
MessageReceivedEvent(messageName:String, value:Object, senderId:int)
| MessageReceivedEvent | ||
clone():Event
| MessageReceivedEvent | ||
isFromServer():Boolean
Returns true if the message was sent by the whirled game server or by the game's server
agent.
| MessageReceivedEvent | ||
toString():String
| MessageReceivedEvent |
Constant | Defined by | ||
---|---|---|---|
MESSAGE_RECEIVED : String = "MsgReceived" [static]
The type of all MessageReceivedEvents.
| MessageReceivedEvent |
Constant | Defined by | ||
---|---|---|---|
SERVER_AGENT_ID : int = -2.147483648E9 [static]
Sender id indicating that the message is from the game's server agent.
| MessageReceivedEvent | ||
SERVER_ID : int = 0 [static]
Sender id indicating that the message is from the whirled game server.
| MessageReceivedEvent |
name | property |
name:String
[read-only]Access the message name.
Implementation public function get name():String
senderId | property |
senderId:int
[read-only]
Access the id of the occupant that sent the message. The value may not correspond to a real
occupant id if isFromServer
returns true.
public function get senderId():int
See also
value | property |
value:Object
[read-only]Access the message value.
Implementation public function get value():Object
MessageReceivedEvent | () | constructor |
public function MessageReceivedEvent(messageName:String, value:Object, senderId:int)
Parameters
messageName:String |
|
value:Object |
|
senderId:int |
clone | () | method |
public override function clone():Event
Returns
Event |
isFromServer | () | method |
public function isFromServer():Boolean
Returns true if the message was sent by the whirled game server or by the game's server agent.
ReturnsBoolean |
toString | () | method |
public override function toString():String
Returns
String |
MESSAGE_RECEIVED | constant |
public static const MESSAGE_RECEIVED:String = "MsgReceived"
The type of all MessageReceivedEvents.
SERVER_AGENT_ID | constant |
protected static const SERVER_AGENT_ID:int = -2.147483648E9
Sender id indicating that the message is from the game's server agent. TODO: does this need to be public?
SERVER_ID | constant |
protected static const SERVER_ID:int = 0
Sender id indicating that the message is from the whirled game server. TODO: does this need to be public?