RoomProperties
The predefined properties that can be used in matching expressions to search/filter Rooms.
new RoomProperties()
Developers never istantiate the RoomProperties class: only use its static properties.
Properties
GROUP_ID string
The name of the Group to which the Room belongs.
Requires a StringMatch instance to be used for values comparison.
- See also
- MatchExpression
- StringMatch
- SFSRoom#groupId
HAS_FREE_PLAYER_SLOTS string
The Room has at least one free player slot.
Requires a BoolMatch instance to be used for values comparison.
- See also
- MatchExpression
- BoolMatch
IS_GAME string
The Room is a Game Room.
Requires a BoolMatch instance to be used for values comparison.
- See also
- MatchExpression
- BoolMatch
- SFSRoom#isGame
IS_PRIVATE string
The Room is private.
Requires a BoolMatch instance to be used for values comparison.
IS_TYPE_DEFAULT string
The Room is of default type on the server-side.
Requires a BoolMatch instance to be used for values comparison.
- See also
- MatchExpression
- BoolMatch
IS_TYPE_MMO string
The Room is an MMORoom on the server-side.
Requires a BoolMatch instance to be used for values comparison.
- See also
- MatchExpression
- BoolMatch
IS_TYPE_SFSGAME string
The Room is an SFSGame on the server-side.
Requires a BoolMatch instance to be used for values comparison.
- See also
- MatchExpression
- BoolMatch
MAX_SPECTATORS string
The maximum number of spectators allowed in the Room (Game Rooms only).
Requires a NumberMatch instance to be used for values comparison.
MAX_USERS string
The maximum number of users allowed in the Room (players in Game Rooms).
Requires a NumberMatch instance to be used for values comparison.
- See also
- MatchExpression
- NumberMatch
- SFSRoom#maxUsers
NAME string
The Room name.
Requires a StringMatch instance to be used for values comparison.
- See also
- MatchExpression
- StringMatch
- SFSRoom#name
SPECTATOR_COUNT string
The Room spectators count (Game Rooms only).
Requires a NumberMatch instance to be used for values comparison.
USER_COUNT string
The Room users count (players in Game Rooms).
Requires a NumberMatch instance to be used for values comparison.
- See also
- MatchExpression
- NumberMatch
- SFSRoom#userCount