Edit

PFLobby Search Keys

  • Article

Values representing the lobby's predefined search keys.

Syntax

constexpr char PFLobbyMemberCountSearchKey[] = "lobby/memberCount";
constexpr char PFLobbyMemberCountRemainingSearchKey[] = "lobby/memberCountRemaining"
constexpr char PFLobbyAmMemberSearchKey[] = "lobby/amMember";
constexpr char PFLobbyAmOwnerSearchKey[] = "lobby/amOwner";
constexpr char PFLobbyMembershipLockSearchKey[] = "lobby/membershipLock";
constexpr char PFLobbyAmServerSearchKey[] = "lobby/amServer"

Constants

Constant Description Example
PFLobbyMemberCountSearchKey A special, predefined search key that can be used in the PFLobbySearchConfiguration filtering and sorting strings to search for lobbies based on the current number of members in the lobby. "lobby/memberCount lt 5"
PFLobbyMemberCountRemainingSearchKey A special, predefined search key that can be used in the PFLobbySearchConfiguration filtering and sorting strings to search for lobbies based on the number of remaining members who can join the lobby. "lobby/memberCountRemaining gt 0"
PFLobbyAmMemberSearchKey A special, predefined search key that can be used in the PFLobbySearchConfiguration filtering string to search for lobbies that you are currently a member of. "lobby/amMember eq true"
PFLobbyAmOwnerSearchKey A special, predefined search key that can be used in the PFLobbySearchConfiguration filtering string to search for lobbies that you own. "lobby/amOwner eq true"
PFLobbyMembershipLockSearchKey A special, predefined search key that can be used in the PFLobbySearchConfiguration filtering string to search for lobbies with a specific lock state. "lobby/membershipLock eq 'Unlocked'"
PFLobbyAmServerSearchKey A special, predefined search key that can be used in the PFLobbySearchConfiguration filtering string to search for lobbies that the server has joined but does not own. "lobby/amServer eq true"

Requirements

Header: PFLobby.h

See also

PFLobbySearchConfiguration