Класс Room. SmartFoxServer

Класс Room- класс, осуществляющий доступ к информации комнаты SmartFoxServer.

Полное определение класса: it.gotoandplay.smartfoxserver.data.Room

Методы:

getUserList (): Array
Возвращает ассоциативный массив объектов User пользователей комнаты. В качестве ключевых значений массива выступают идентификаторы пользователей.

getUser (userId:*) : User
Возвращает параметры пользователя, находящегося в комнате.
userId : идентификатор (int) или имя (String) пользователя.

getVariable (varName:String) : *
Возвращает переменную комнаты.
varName : имя запрашиваемой переменной.
ОЧЕНЬ ВАЖНО: Объект Room не будет получать переменные, если в конфигурации параметр roomListVars не установлен, или установлен в false. Методы getVariable() и getVariables() не будут возвращать никаких переменных.

getVariables () : Array
Возвращает ассоциативный список переменных, где в качестве ключей используются имена переменных.

getName () : String
Возвращает имя комнаты.

getId () : int
Возвращает идентификатор комнаты.

isTemp () : Boolean
Если true, комната является временной. Всегда true для комнат, созданных во время работы приложения на стороне клиента (?).

isGame () : Boolean
Комната является игровой.

isPrivate () : Boolean
Комната является приватной.

getUserCount () : int
Возвращает число пользователей в комнате.
ВАЖНО: В игровых комнатах важно различать количество пользователей и количество наблюдателей. Количество пользователей здесь - это не общее число пользователей, а только число игроков. Соответственно, общее число пользователей в игровой комнате равно getUserCount()+getSpectatorCount().

getSpectatorCount () : int
Возвращает число наблюдателей в комнате. (Только для игровых комнат).

getMaxUsers () : int
Возвращает максимальное число пользователей, которые могут войти в комнату.

getMaxSpectators () : int
Возвращает максимальное число наблюдателей, которые могут войти в комнату. (Только для игровых комнат).

getMyPlayerIndex () : int
Возвращает идентификатор игрока текущего пользователя в комнате. Отсчитывается от 1, для наблюдателей равен -1.

isLimbo () : Boolean
Комната работает в режиме "limbo" (рассчитана на очень большое количество пользователей).