| Package | com.electrotank.electroserver4.room |
| Class | public class Room |
| Method | Defined by | ||
|---|---|---|---|
|
Room()
Creates a new instance of the Room class.
| Room | ||
|
addRoomVariable(rv:RoomVariable):void
Used internally to add a room variable.
| Room | ||
|
Adds a usre to the room.
| Room | ||
|
doesRoomVariableExist(name:String):Boolean
Checks to see if a room variable exist based on a name.
| Room | ||
|
getCapacity():Number
Gets the room capacity.
| Room | ||
|
getDescription():String
Gets the description property of the room.
| Room | ||
|
getHasPassword():Boolean
Gets the hasPassword property.
| Room | ||
|
getIsHidden():Boolean
Gets the hidden status.
| Room | ||
|
getIsJoined():Boolean
Returns true if you are joined to this room, false otherwise.
| Room | ||
|
getPassword():String
Gets the room's password.
| Room | ||
|
getRoomId():Number
Gets the id of the room.
| Room | ||
|
getRoomName():String
Gets the name of the room.
| Room | ||
|
getRoomVariable(name:String):RoomVariable
Finds a room variable based on the name and returns it.
| Room | ||
|
getRoomVariables():Array
Gets the entire list of room variables.
| Room | ||
|
getUserById(str:String):User
Gets a user based on a user id.
| Room | ||
|
getUserCount():Number
Gets the user count for the room.
| Room | ||
|
getUsers():Array
Gets the full user list for this room.
| Room | ||
|
Gets the zone that the room is in.
| Room | ||
|
getZoneId():Number
Gets the id of the zone that holds the room.
| Room | ||
|
removeRoomVariable(name:String):void
Used internally to remove a room variable.
| Room | ||
|
removeUser(userId:String):void
Removes a user from the room.
| Room | ||
|
setCapacity(num:Number):void
Sets the capacity of the room.
| Room | ||
|
setDescription(des:String):void
Sets the description property of the room.
| Room | ||
|
setHasPassword(val:Boolean):void
Sets the hasPassword property of the room.
| Room | ||
|
setIsHidden(val:Boolean):void
Sets the isHidden property of the room.
| Room | ||
|
setIsJoined(isJoined:Boolean):void
Sets the isJoined property of the class intance.
| Room | ||
|
setPassword(str:String):void
Sets the room's password.
| Room | ||
|
setRoomId(rId:Number):void
Sets the id of the room.
| Room | ||
|
setRoomName(name:String):void
Sets the name of the room.
| Room | ||
|
setRoomVariables(arr:Array):void
Sets the entire list of room variables.
| Room | ||
|
setUserCount(count:Number):void
Sets the user count for the room.
| Room | ||
|
Sets the zone that the room is in.
| Room | ||
|
setZoneId(zId:Number):void
Sets the id of the zone that holds the room.
| Room | ||
| Room | () | constructor |
public function Room()Creates a new instance of the Room class.
| addRoomVariable | () | method |
public function addRoomVariable(rv:RoomVariable):voidUsed internally to add a room variable.
Parametersrv:RoomVariable — Room variable to add to the room.
|
| addUser | () | method |
public function addUser(user:User):voidAdds a usre to the room. This is used internally by the API.
Parametersuser:User — The user to be added to the room.
|
| doesRoomVariableExist | () | method |
public function doesRoomVariableExist(name:String):BooleanChecks to see if a room variable exist based on a name. If it exists then the method returns true. If it does not exist, then the method returns false.
Parametersname:String — The name of the room variable.
|
Boolean — True or false.
|
| getCapacity | () | method |
public function getCapacity():NumberGets the room capacity. If -1 then there is no limit.
ReturnsNumber — Gets the room capacity.
|
| getDescription | () | method |
public function getDescription():StringGets the description property of the room.
ReturnsString — The description property of the room.
|
| getHasPassword | () | method |
public function getHasPassword():BooleanGets the hasPassword property.
ReturnsBoolean — The hasPassword property.
|
| getIsHidden | () | method |
public function getIsHidden():BooleanGets the hidden status.
ReturnsBoolean — True or false.
|
| getIsJoined | () | method |
public function getIsJoined():BooleanReturns true if you are joined to this room, false otherwise.
ReturnsBoolean — True or false.
|
| getPassword | () | method |
public function getPassword():StringGets the room's password.
ReturnsString — The room's password.
|
| getRoomId | () | method |
public function getRoomId():NumberGets the id of the room.
ReturnsNumber — The id of the room.
|
| getRoomName | () | method |
public function getRoomName():StringGets the name of the room.
ReturnsString — The name of the room.
|
| getRoomVariable | () | method |
public function getRoomVariable(name:String):RoomVariableFinds a room variable based on the name and returns it.
Parametersname:String — Name of the room variable.
|
RoomVariable —
Room variable instance.
|
| getRoomVariables | () | method |
public function getRoomVariables():ArrayGets the entire list of room variables.
ReturnsArray — The entire list of room variables.
|
| getUserById | () | method |
public function getUserById(str:String):UserGets a user based on a user id.
Parametersstr:String — The user id.
|
User —
The user who has the id passed in.
|
| getUserCount | () | method |
public function getUserCount():NumberGets the user count for the room.
ReturnsNumber — The user count for the room.
|
| getUsers | () | method |
public function getUsers():ArrayGets the full user list for this room.
ReturnsArray — The full user list for this room.
|
| getZone | () | method |
public function getZone():ZoneGets the zone that the room is in.
ReturnsZone —
The zone that the room is in.
|
| getZoneId | () | method |
public function getZoneId():NumberGets the id of the zone that holds the room.
ReturnsNumber — The id of the zone that holds the room.
|
| removeRoomVariable | () | method |
public function removeRoomVariable(name:String):voidUsed internally to remove a room variable.
Parametersname:String — Name of room variable to remove.
|
| removeUser | () | method |
public function removeUser(userId:String):voidRemoves a user from the room.
ParametersuserId:String — The id of the user to remove.
|
| setCapacity | () | method |
public function setCapacity(num:Number):voidSets the capacity of the room. If -1 then there is no limit. If 1 or greater, then that is the total number of users allowed to join.
Parametersnum:Number — The room capacity.
|
| setDescription | () | method |
public function setDescription(des:String):voidSets the description property of the room.
Parametersdes:String — The description property of the room.
|
| setHasPassword | () | method |
public function setHasPassword(val:Boolean):voidSets the hasPassword property of the room. If true then a password is required to join the room.
Parametersval:Boolean — True or false.
|
| setIsHidden | () | method |
public function setIsHidden(val:Boolean):voidSets the isHidden property of the room. If isHidden is true, then the room does not appear to exist to users not in the room.
Parametersval:Boolean — True or false.
|
| setIsJoined | () | method |
public function setIsJoined(isJoined:Boolean):voidSets the isJoined property of the class intance. It is set to true if you are joined to the room.
ParametersisJoined:Boolean — True or false.
|
| setPassword | () | method |
public function setPassword(str:String):voidSets the room's password.
Parametersstr:String — str
|
| setRoomId | () | method |
public function setRoomId(rId:Number):voidSets the id of the room.
ParametersrId:Number — The id of the room.
|
| setRoomName | () | method |
public function setRoomName(name:String):voidSets the name of the room.
Parametersname:String — The name of the room.
|
| setRoomVariables | () | method |
public function setRoomVariables(arr:Array):voidSets the entire list of room variables.
Parametersarr:Array — List of room variables.
|
| setUserCount | () | method |
public function setUserCount(count:Number):voidSets the user count for the room.
Parameterscount:Number — The user count for the room.
|
| setZone | () | method |
public function setZone(tmpzone:Zone):voidSets the zone that the room is in.
Parameterstmpzone:Zone — The zone tha tthe room is in.
|
| setZoneId | () | method |
public function setZoneId(zId:Number):voidSets the id of the zone that holds the room.
ParameterszId:Number — The id of the zone that holds the room.
|