| Package | com.electrotank.electroserver4.message.event |
| Class | public class UserEvictedFromRoomEvent |
| Inheritance | UserEvictedFromRoomEvent  EventImpl MessageImpl |
| Property | Defined by | ||
|---|---|---|---|
 | target : Object | MessageImpl | |
| type : String | MessageImpl | |
| user : User | UserEvictedFromRoomEvent | ||
| Method | Defined by | ||
|---|---|---|---|
| UserEvictedFromRoomEvent | |||
|
getDuration():Number
| UserEvictedFromRoomEvent | ||
|
getIsRealServerMessage():Boolean
Used internally when one client-request needs to be remapped to a server request.
| MessageImpl | |
|
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 | |
|
getReason():String
| UserEvictedFromRoomEvent | ||
|
getRoomId():Number
| UserEvictedFromRoomEvent | ||
|
getUserId():String
| UserEvictedFromRoomEvent | ||
|
getZoneId():Number
| UserEvictedFromRoomEvent | ||
|
isBan():Boolean
| UserEvictedFromRoomEvent | ||
|
setBan(val:Boolean):void
| UserEvictedFromRoomEvent | ||
|
setDuration(num:Number):void
| UserEvictedFromRoomEvent | ||
|
setIsRealServerMessage(isRealServerMessage:Boolean):void
Used internally when one client-request needs to be remapped to a server request.
| MessageImpl | |
|
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 | |
|
setReason(str:String):void
| UserEvictedFromRoomEvent | ||
|
setRoomId(num:Number):void
| UserEvictedFromRoomEvent | ||
|
setUserId(str:String):void
| UserEvictedFromRoomEvent | ||
|
setZoneId(num:Number):void
| UserEvictedFromRoomEvent | ||
|
Every messages have varying optional fields.
| MessageImpl | |
| user | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesuser:User [read-write]Implementation
public function get user():User
public function set user(value:User):void
| UserEvictedFromRoomEvent | () | constructor |
public function UserEvictedFromRoomEvent()
| getDuration | () | method |
public function getDuration():Number
Returns
Number |
| getReason | () | method |
public function getReason():String
Returns
String |
| getRoomId | () | method |
public function getRoomId():Number
Returns
Number |
| getUserId | () | method |
public function getUserId():String
Returns
String |
| getZoneId | () | method |
public function getZoneId():Number
Returns
Number |
| isBan | () | method |
public function isBan():Boolean
Returns
Boolean |
| setBan | () | method |
public function setBan(val:Boolean):voidParameters
val:Boolean |
| setDuration | () | method |
public function setDuration(num:Number):voidParameters
num:Number |
| setReason | () | method |
public function setReason(str:String):voidParameters
str:String |
| setRoomId | () | method |
public function setRoomId(num:Number):voidParameters
num:Number |
| setUserId | () | method |
public function setUserId(str:String):voidParameters
str:String |
| setZoneId | () | method |
public function setZoneId(num:Number):voidParameters
num:Number |