| Package | com.electrotank.electroserver5.zone |
| Class | public class Room |
| Inheritance | Room  Object |
| Property | Defined By | ||
|---|---|---|---|
| capacity : Number
Returns the allowable capacity for the room. | Room | ||
| description : String
Gets the description proeprty for this room. | Room | ||
| hasPassword : Boolean
Returns 'true' if the room is password protected. | Room | ||
| id : int
Gets the id of the room. | Room | ||
| isHidden : Boolean
Returns 'true' if the room is hidden. | Room | ||
| isJoined : Boolean [read-only]
Returns 'true' if you belong to this room. | Room | ||
| name : String
Gets the name of the room. | Room | ||
| password : String
Gets the password for this room, if any. | Room | ||
| roomVariables : Array [read-only]
Gets the list of RoomVariable objects. | Room | ||
| userCount : Number
Gets the number of users in this room. | Room | ||
| users : Array [read-only]
Gets the list of Users in this room. | Room | ||
| zoneId : int
Gets the zoneId for this room. | Room | ||
| Method | Defined By | ||
|---|---|---|---|
Room()
Creates a new Room instance. | Room | ||
roomVariableByName(name:String):RoomVariable
Gets a RoomVariable object by name. | Room | ||
| capacity | property |
capacity:NumberReturns the allowable capacity for the room.
public function get capacity():Number public function set capacity(value:Number):void| description | property |
description:StringGets the description proeprty for this room.
public function get description():String public function set description(value:String):void| hasPassword | property |
hasPassword:BooleanReturns 'true' if the room is password protected.
public function get hasPassword():Boolean public function set hasPassword(value:Boolean):void| id | property |
id:intGets the id of the room.
public function get id():int public function set id(value:int):void| isHidden | property |
isHidden:BooleanReturns 'true' if the room is hidden.
public function get isHidden():Boolean public function set isHidden(value:Boolean):void| isJoined | property |
isJoined:Boolean [read-only] Returns 'true' if you belong to this room.
public function get isJoined():Boolean| name | property |
name:StringGets the name of the room.
public function get name():String public function set name(value:String):void| password | property |
password:StringGets the password for this room, if any.
public function get password():String public function set password(value:String):void| roomVariables | property |
roomVariables:Array [read-only] Gets the list of RoomVariable objects.
public function get roomVariables():Array| userCount | property |
userCount:NumberGets the number of users in this room.
public function get userCount():Number public function set userCount(value:Number):void| users | property |
users:Array [read-only] Gets the list of Users in this room.
public function get users():Array| zoneId | property |
zoneId:intGets the zoneId for this room.
public function get zoneId():int public function set zoneId(value:int):void| Room | () | Constructor |
public function Room()Creates a new Room instance.
| roomVariableByName | () | method |
public function roomVariableByName(name:String):RoomVariableGets a RoomVariable object by name.
Parameters
name:String — of the variable to find.
|
RoomVariable — RoomVariable object that has the name passed in.
|