Class RoomProperties


  • public final class RoomProperties
    extends java.lang.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
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String GROUP_ID
      The name of the Group to which the Room belongs.
      static java.lang.String HAS_FREE_PLAYER_SLOTS
      The Room has at least one free player slot.
      static java.lang.String IS_GAME
      The Room is a Game Room.
      static java.lang.String IS_PRIVATE
      The Room is private.
      static java.lang.String IS_TYPE_DEFAULT
      The Room is of default type on the server-side (i.e. not an MMORoom or SFSGame).
      static java.lang.String IS_TYPE_MMO
      The Room is an MMORoom on the server-side.
      static java.lang.String IS_TYPE_SFSGAME
      The Room is an SFSGame on the server-side.
      static java.lang.String MAX_SPECTATORS
      The maximum number of spectators allowed in the Room (Game Rooms only).
      static java.lang.String MAX_USERS
      The maximum number of users allowed in the Room (players in Game Rooms).
      static java.lang.String NAME
      The Room name.
      static java.lang.String SPECTATOR_COUNT
      The Room spectators count (Game Rooms only).
      static java.lang.String USER_COUNT
      The Room users count (players in Game Rooms).
    • Method Summary

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • NAME

        public static java.lang.String NAME
        The Room name. Requires a StringMatcher to be used for values comparison.
      • GROUP_ID

        public static java.lang.String GROUP_ID
        The name of the Group to which the Room belongs. Requires a StringMatcher to be used for values comparison.
      • MAX_USERS

        public static java.lang.String MAX_USERS
        The maximum number of users allowed in the Room (players in Game Rooms). Requires a NumberMatcher to be used for values comparison.
      • MAX_SPECTATORS

        public static java.lang.String MAX_SPECTATORS
        The maximum number of spectators allowed in the Room (Game Rooms only). Requires a NumberMatcher to be used for values comparison.
      • USER_COUNT

        public static java.lang.String USER_COUNT
        The Room users count (players in Game Rooms). Requires a NumberMatcher to be used for values comparison.
      • SPECTATOR_COUNT

        public static java.lang.String SPECTATOR_COUNT
        The Room spectators count (Game Rooms only). Requires a NumberMatcher to be used for values comparison.
      • IS_GAME

        public static java.lang.String IS_GAME
        The Room is a Game Room. Requires a BoolMatcher to be used for values comparison.
      • IS_PRIVATE

        public static java.lang.String IS_PRIVATE
        The Room is private. Requires a BoolMatcher to be used for values comparison.
      • HAS_FREE_PLAYER_SLOTS

        public static java.lang.String HAS_FREE_PLAYER_SLOTS
        The Room has at least one free player slot. Requires a BoolMatcher to be used for values comparison.
      • IS_TYPE_SFSGAME

        public static java.lang.String IS_TYPE_SFSGAME
        The Room is an SFSGame on the server-side. Requires a BoolMatcher to be used for values comparison.
      • IS_TYPE_MMO

        public static final java.lang.String IS_TYPE_MMO
        The Room is an MMORoom on the server-side. Requires a BoolMatcher to be used for values comparison.
        Since:
        1.8.x
        See Also:
        Constant Field Values
      • IS_TYPE_DEFAULT

        public static final java.lang.String IS_TYPE_DEFAULT
        The Room is of default type on the server-side (i.e. not an MMORoom or SFSGame). Requires a BoolMatcher to be used for values comparison.
        Since:
        1.8.x
        See Also:
        Constant Field Values