sfs3::entities::match::UserProperties Namespace Reference

The UserProperties constants are the names of predefined user properties that can be used in matching expressions to search/filter users, in place of a User Variable name. More...

Variables
constexpr const char *	NAME = "${N}"
	The user name.
constexpr const char *	IS_PLAYER = "${ISP}"
	The user is a player in a Game Room.
constexpr const char *	IS_SPECTATOR = "${ISS}"
	The user is a spectator in a Game Room.
constexpr const char *	IS_NPC = "${ISN}"
	The user is a Non-Player Character (NPC).
constexpr const char *	PRIVILEGE_ID = "${PRID}"
	The user privilege id.
constexpr const char *	IS_IN_ANY_ROOM = "${IAR}"
	The user joined at least one Room.

Detailed Description

The UserProperties constants are the names of predefined user properties that can be used in matching expressions to search/filter users, in place of a User Variable name.

See also

MatchExpression

sfs3::entities::User

Variable Documentation

NAME

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

inlineconstexpr

The user name.

Requires a StringMatch condition to be used for values comparison.

IS_PLAYER

const char* sfs3::entities::match::UserProperties::IS_PLAYER = "${ISP}"

inlineconstexpr

The user is a player in a Game Room.

Requires a BoolMatch condition to be used for values comparison.

IS_SPECTATOR

const char* sfs3::entities::match::UserProperties::IS_SPECTATOR = "${ISS}"

inlineconstexpr

The user is a spectator in a Game Room.

Requires a BoolMatch condition to be used for values comparison.

IS_NPC

const char* sfs3::entities::match::UserProperties::IS_NPC = "${ISN}"

inlineconstexpr

The user is a Non-Player Character (NPC).

Requires a BoolMatch condition to be used for values comparison.

PRIVILEGE_ID

const char* sfs3::entities::match::UserProperties::PRIVILEGE_ID = "${PRID}"

inlineconstexpr

The user privilege id.

Requires a NumberMatch condition to be used for values comparison.

See also

sfs3::entities::UserPrivileges

IS_IN_ANY_ROOM

const char* sfs3::entities::match::UserProperties::IS_IN_ANY_ROOM = "${IAR}"

inlineconstexpr

The user joined at least one Room.

Requires a BoolMatch condition to be used for values comparison.

NOTE: the server resolves this property to joinedRooms.size() == 0, so it evaluates to true for users that joined no Room — the inverse of what the name suggests. Match against false to find users in at least one Room.