| Package | com.electrotank.electroserver4.message.event |
| Class | public class PublicMessageEvent |
| Inheritance | PublicMessageEvent  EventImpl MessageImpl |
| Property | Defined by | ||
|---|---|---|---|
| room : Room | PublicMessageEvent | ||
 | target : Object | MessageImpl | |
| type : String | MessageImpl | |
| user : User | PublicMessageEvent | ||
| Method | Defined by | ||
|---|---|---|---|
| PublicMessageEvent | |||
| PublicMessageEvent | |||
|
getIsRealServerMessage():Boolean
Used internally when one client-request needs to be remapped to a server request.
| MessageImpl | |
|
getMessage():String
| PublicMessageEvent | ||
|
getMessageId():Number
The id of the message.
| MessageImpl | |
|
The type of message being used.
| MessageImpl | |
|
If this is not a real message, then get it.
| MessageImpl | |
|
getRoomId():Number
| PublicMessageEvent | ||
|
getUserId():String
| PublicMessageEvent | ||
|
getUserName():String
| PublicMessageEvent | ||
|
getZoneId():Number
| PublicMessageEvent | ||
|
isUserNameIncluded():Boolean
| PublicMessageEvent | ||
|
setEsObject(eob:EsObject):void
| PublicMessageEvent | ||
|
setIsRealServerMessage(isRealServerMessage:Boolean):void
Used internally when one client-request needs to be remapped to a server request.
| MessageImpl | |
|
setMessage(mess:String):void
| PublicMessageEvent | ||
|
setMessageId(id:Number):void
The id of the message.
| MessageImpl | |
|
setMessageType(mt:MessageType):void
This defines the type of message being used, such as LoginRequest or CreateRoomVariableRequest.
| MessageImpl | |
|
setRoomId(num:Number):void
| PublicMessageEvent | ||
|
setUserId(num:String):void
| PublicMessageEvent | ||
|
setUserName(str:String):void
| PublicMessageEvent | ||
|
setUserNameIncluded(val:Boolean):void
| PublicMessageEvent | ||
|
setZoneId(num:Number):void
| PublicMessageEvent | ||
|
Every messages have varying optional fields.
| MessageImpl | |
| room | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesroom:Room [read-write]Implementation
public function get room():Room
public function set room(value:Room):void
| user | property |
user:User [read-write]Implementation
public function get user():User
public function set user(value:User):void
| PublicMessageEvent | () | constructor |
public function PublicMessageEvent()
| getEsObject | () | method |
| getMessage | () | method |
public function getMessage():String
Returns
String |
| getRoomId | () | method |
public function getRoomId():Number
Returns
Number |
| getUserId | () | method |
public function getUserId():String
Returns
String |
| getUserName | () | method |
public function getUserName():String
Returns
String |
| getZoneId | () | method |
public function getZoneId():Number
Returns
Number |
| isUserNameIncluded | () | method |
public function isUserNameIncluded():Boolean
Returns
Boolean |
| setEsObject | () | method |
| setMessage | () | method |
public function setMessage(mess:String):voidParameters
mess:String |
| setRoomId | () | method |
public function setRoomId(num:Number):voidParameters
num:Number |
| setUserId | () | method |
public function setUserId(num:String):voidParameters
num:String |
| setUserName | () | method |
public function setUserName(str:String):voidParameters
str:String |
| setUserNameIncluded | () | method |
public function setUserNameIncluded(val:Boolean):voidParameters
val:Boolean |
| setZoneId | () | method |
public function setZoneId(num:Number):voidParameters
num:Number |