sfs3::entities::match::RoomProperties Namespace Reference

The RoomProperties constants are the names of predefined Room properties that can be used in matching expressions to search/filter Rooms, in place of a Room Variable name. More...

Variables
constexpr const char *	NAME = "${N}"
	The Room name.
constexpr const char *	GROUP_ID = "${G}"
	The name of the Group to which the Room belongs.
constexpr const char *	MAX_USERS = "${MXU}"
	The maximum number of users allowed in the Room (players in Game Rooms).
constexpr const char *	MAX_SPECTATORS = "${MXS}"
	The maximum number of spectators allowed in the Room (Game Rooms only).
constexpr const char *	USER_COUNT = "${UC}"
	The Room users count (players in Game Rooms).
constexpr const char *	SPECTATOR_COUNT = "${SC}"
	The Room spectators count (Game Rooms only).
constexpr const char *	IS_GAME = "${ISG}"
	The Room is a Game Room.
constexpr const char *	IS_PRIVATE = "${ISP}"
	The Room is private (password protected).
constexpr const char *	HAS_FREE_PLAYER_SLOTS = "${HFP}"
	The Room has at least one free player slot.
constexpr const char *	IS_TYPE_SFSGAME = "${IST}"
	The Room is an SFSGame on the server-side.
constexpr const char *	IS_TYPE_MMO = "${ISM}"
	The Room is an MMORoom on the server-side.
constexpr const char *	IS_TYPE_DEFAULT = "${ISD}"
	The Room is a plain SFSRoom on the server-side (neither a Game Room nor an MMORoom).

Detailed Description

The RoomProperties constants are the names of predefined Room properties that can be used in matching expressions to search/filter Rooms, in place of a Room Variable name.

See also

MatchExpression

sfs3::entities::Room

Variable Documentation

NAME

const char* sfs3::entities::match::RoomProperties::NAME = "${N}"

inlineconstexpr

The Room name.

Requires a StringMatch condition to be used for values comparison.

GROUP_ID

const char* sfs3::entities::match::RoomProperties::GROUP_ID = "${G}"

inlineconstexpr

The name of the Group to which the Room belongs.

Requires a StringMatch condition to be used for values comparison.

MAX_USERS

const char* sfs3::entities::match::RoomProperties::MAX_USERS = "${MXU}"

inlineconstexpr

The maximum number of users allowed in the Room (players in Game Rooms).

Requires a NumberMatch condition to be used for values comparison.

MAX_SPECTATORS

const char* sfs3::entities::match::RoomProperties::MAX_SPECTATORS = "${MXS}"

inlineconstexpr

The maximum number of spectators allowed in the Room (Game Rooms only).

Requires a NumberMatch condition to be used for values comparison.

USER_COUNT

const char* sfs3::entities::match::RoomProperties::USER_COUNT = "${UC}"

inlineconstexpr

The Room users count (players in Game Rooms).

Requires a NumberMatch condition to be used for values comparison.

SPECTATOR_COUNT

const char* sfs3::entities::match::RoomProperties::SPECTATOR_COUNT = "${SC}"

inlineconstexpr

The Room spectators count (Game Rooms only).

Requires a NumberMatch condition to be used for values comparison.

IS_GAME

const char* sfs3::entities::match::RoomProperties::IS_GAME = "${ISG}"

inlineconstexpr

The Room is a Game Room.

Requires a BoolMatch condition to be used for values comparison.

IS_PRIVATE

const char* sfs3::entities::match::RoomProperties::IS_PRIVATE = "${ISP}"

inlineconstexpr

The Room is private (password protected).

Requires a BoolMatch condition to be used for values comparison.

HAS_FREE_PLAYER_SLOTS

const char* sfs3::entities::match::RoomProperties::HAS_FREE_PLAYER_SLOTS = "${HFP}"

inlineconstexpr

The Room has at least one free player slot.

Requires a BoolMatch condition to be used for values comparison.

IS_TYPE_SFSGAME

const char* sfs3::entities::match::RoomProperties::IS_TYPE_SFSGAME = "${IST}"

inlineconstexpr

The Room is an SFSGame on the server-side.

Requires a BoolMatch condition to be used for values comparison.

IS_TYPE_MMO

const char* sfs3::entities::match::RoomProperties::IS_TYPE_MMO = "${ISM}"

inlineconstexpr

The Room is an MMORoom on the server-side.

Requires a BoolMatch condition to be used for values comparison.

IS_TYPE_DEFAULT

const char* sfs3::entities::match::RoomProperties::IS_TYPE_DEFAULT = "${ISD}"

inlineconstexpr

The Room is a plain SFSRoom on the server-side (neither a Game Room nor an MMORoom).

Requires a BoolMatch condition to be used for values comparison.