RoomProperties

Contains the names of predefined properties that can be used in matching expressions to search/filter Rooms.

Members

(static, constant) GROUP_ID :string

Name of the Group to which the Room belongs.

Requires a StringMatch for value comparison.

Type:
  • string

(static, constant) HAS_FREE_PLAYER_SLOTS :string

Room has at least one free Player slot.

Requires a BoolMatch for value comparison.

Type:
  • string

(static, constant) IS_GAME :string

Room is a Game Room.

Requires a BoolMatch for value comparison.

Type:
  • string

(static, constant) IS_PRIVATE :string

Room is private.

Requires a BoolMatch for value comparison.

Type:
  • string

(static, constant) IS_TYPE_DEFAULT :string

Room is of default type on the server side (i.e. not an MMORoom or SFSGame).

Requires a BoolMatch for value comparison.

Type:
  • string

(static, constant) IS_TYPE_MMO :string

Room is of type MMORoom on the server side.

Requires a BoolMatch for value comparison.

Type:
  • string

(static, constant) IS_TYPE_SFSGAME :string

Room is of type SFSGame on the server side.

Requires a BoolMatch for value comparison.

Type:
  • string

(static, constant) MAX_SPECTATORS :string

Maximum number of Spectators allowed to join the Room (Game Room only).

Requires a NumberMatch for value comparison.

Type:
  • string

(static, constant) MAX_USERS :string

Maximum number of Users allowed to join the Room (Players for Game Room).

Requires a NumberMatch for value comparison.

Type:
  • string

(static, constant) NAME :string

Room name.

Requires a StringMatch for value comparison.

Type:
  • string

(static, constant) SPECTATOR_COUNT :string

Spectator count in Room (Game Room only).

Requires a NumberMatch for value comparison.

Type:
  • string

(static, constant) USER_COUNT :string

User count in Room (Player count in Game Room).

Requires a NumberMatch for value comparison.

Type:
  • string