Packagecom.smartfoxserver.v2.entities.match
Classpublic class RoomProperties
InheritanceRoomProperties Inheritance Object

The RoomProperties class contains the names of predefined properties that can be used in matching expressions to search/filter Rooms.

See also

MatchExpression
Room


Public Constants
 ConstantDefined By
  GROUP_ID : String = ${G}
[static] The name of the Group to which the Room belongs.
RoomProperties
  HAS_FREE_PLAYER_SLOTS : String = ${HFP}
[static] The Room has at least one free player slot.
RoomProperties
  IS_GAME : String = ${ISG}
[static] The Room is a Game Room.
RoomProperties
  IS_PRIVATE : String = ${ISP}
[static] The Room is private.
RoomProperties
  IS_TYPE_SFSGAME : String = ${IST}
[static] The Room is an SFSGame on the server-side.
RoomProperties
  MAX_SPECTATORS : String = ${MXS}
[static] The maximum number of spectators allowed in the Room (Game Rooms only).
RoomProperties
  MAX_USERS : String = ${MXU}
[static] The maximum number of users allowed in the Room (players in Game Rooms).
RoomProperties
  NAME : String = ${N}
[static] The Room name.
RoomProperties
  SPECTATOR_COUNT : String = ${SC}
[static] The Room spectators count (Game Rooms only).
RoomProperties
  USER_COUNT : String = ${UC}
[static] The Room users count (players in Game Rooms).
RoomProperties
Constant Detail
GROUP_IDConstant
public static const GROUP_ID:String = ${G}

The name of the Group to which the Room belongs. Requires a StringMatcher to be used for values comparison.

HAS_FREE_PLAYER_SLOTSConstant 
public static const HAS_FREE_PLAYER_SLOTS:String = ${HFP}

The Room has at least one free player slot. Requires a BoolMatcher to be used for values comparison.

IS_GAMEConstant 
public static const IS_GAME:String = ${ISG}

The Room is a Game Room. Requires a BoolMatcher to be used for values comparison.

IS_PRIVATEConstant 
public static const IS_PRIVATE:String = ${ISP}

The Room is private. Requires a BoolMatcher to be used for values comparison.

IS_TYPE_SFSGAMEConstant 
public static const IS_TYPE_SFSGAME:String = ${IST}

The Room is an SFSGame on the server-side. Requires a BoolMatcher to be used for values comparison.

MAX_SPECTATORSConstant 
public static const MAX_SPECTATORS:String = ${MXS}

The maximum number of spectators allowed in the Room (Game Rooms only). Requires a NumberMatcher to be used for values comparison.

MAX_USERSConstant 
public static const MAX_USERS:String = ${MXU}

The maximum number of users allowed in the Room (players in Game Rooms). Requires a NumberMatcher to be used for values comparison.

NAMEConstant 
public static const NAME:String = ${N}

The Room name. Requires a StringMatcher to be used for values comparison.

SPECTATOR_COUNTConstant 
public static const SPECTATOR_COUNT:String = ${SC}

The Room spectators count (Game Rooms only). Requires a NumberMatcher to be used for values comparison.

USER_COUNTConstant 
public static const USER_COUNT:String = ${UC}

The Room users count (players in Game Rooms). Requires a NumberMatcher to be used for values comparison.