gpg::RealTimeRoomConfig

#include <real_time_room_config.h>

A data structure containing the data needed to create a RealTimeRoom object.

Summary

Constructors and Destructors
RealTimeRoomConfig(std::shared_ptr< const RealTimeRoomConfigImpl > impl)
Constructs a RealTimeRoomConfig from object a shared_ptr to a RealTimeRoomConfigImpl object.
RealTimeRoomConfig()
RealTimeRoomConfig(const RealTimeRoomConfig & copy_from)
Creates a copy of an existing RealTimeRoomConfig object.
RealTimeRoomConfig(RealTimeRoomConfig && move_from)
Moves an existing RealTimeRoomConfig object.

Public functions
ExclusiveBitMask() const
int64_t
A bit mask indicating game-specific exclusive roles for the player, such as "attacker" or "defender".
MaximumAutomatchingPlayers() const
uint32_t
The maximum number of auto-matching players to add to the room.
MinimumAutomatchingPlayers() const
uint32_t
The minimum number of auto-matching players to add to the room.
PlayerIdsToInvite() const
const std::vector< std::string > &
The player IDs to invite to the newly created room.
Valid() const
bool
Returns true if this RealTimeRoomConfig object is populated with data.
Variant() const
uint32_t
A developer-specific value used to indicate room type or mode.
operator=(const RealTimeRoomConfig & copy_from)
Assigns this RealTimeRoomConfig object by copying from another one.
operator=(RealTimeRoomConfig && move_from)
Assigns this RealTimeRoomConfig object by moving another one into it.

Classes
gpg::RealTimeRoomConfig::Builder

Builds one or more RealTimeRoomConfig objects.

Public functions

ExclusiveBitMask

int64_t ExclusiveBitMask() const

A bit mask indicating game-specific exclusive roles for the player, such as "attacker" or "defender".

The logical product (AND) of any pairing players must equal zero for auto-match. Can only be called if Valid returns true.

MaximumAutomatchingPlayers

uint32_t MaximumAutomatchingPlayers() const

The maximum number of auto-matching players to add to the room.

Can only be called if Valid returns true.

MinimumAutomatchingPlayers

uint32_t MinimumAutomatchingPlayers() const

The minimum number of auto-matching players to add to the room.

Can only be called if Valid returns true.

PlayerIdsToInvite

const std::vector< std::string > & PlayerIdsToInvite() const

The player IDs to invite to the newly created room.

Can only be called if Valid returns true.

RealTimeRoomConfig

 RealTimeRoomConfig(
  std::shared_ptr< const RealTimeRoomConfigImpl > impl
)

Constructs a RealTimeRoomConfig from object a shared_ptr to a RealTimeRoomConfigImpl object.

Intended for internal use by the API.

RealTimeRoomConfig

 RealTimeRoomConfig()

RealTimeRoomConfig

 RealTimeRoomConfig(
  const RealTimeRoomConfig & copy_from
)

Creates a copy of an existing RealTimeRoomConfig object.

RealTimeRoomConfig

 RealTimeRoomConfig(
  RealTimeRoomConfig && move_from
)

Moves an existing RealTimeRoomConfig object.

Valid

bool Valid() const

Returns true if this RealTimeRoomConfig object is populated with data.

Must return true for the getter functions (PlayerIdsToInvite, MinimumAutoroomingPlayers, etc.) on the RealTimeRoomConfig object to be usable.

Variant

uint32_t Variant() const

A developer-specific value used to indicate room type or mode.

Only players using the same value can room. Can only be called if Valid returns true.

operator=

RealTimeRoomConfig & operator=(
  const RealTimeRoomConfig & copy_from
)

Assigns this RealTimeRoomConfig object by copying from another one.

operator=

RealTimeRoomConfig & operator=(
  RealTimeRoomConfig && move_from
)

Assigns this RealTimeRoomConfig object by moving another one into it.