Stay organized with collections
Save and categorize content based on your preferences.
gpg::TurnBasedMatchConfig::Builder
#include <turn_based_match_config_builder.h>
Builds one or more TurnBasedMatchConfig objects.
Summary
Constructors and Destructors
|
Builder()
|
Public functions
AddAllPlayersToInvite
Builder & AddAllPlayersToInvite(
const std::vector< std::string > & player_ids
)
Adds multiple players to the list of players to invite to the match.
By default, no players are added.
AddPlayerToInvite
Builder & AddPlayerToInvite(
const std::string & player_id
)
Adds a player to the list of players to invite to the match.
By default, no players are added to the match. The builder cannot create a match until players are added.
PopulateFromPlayerSelectUIResponse
Builder & PopulateFromPlayerSelectUIResponse(
const TurnBasedMultiplayerManager::PlayerSelectUIResponse & response
)
Populates values from a TurnBasedMultiplayerManager::ShowPlayerSelectUIResponse.
Note that this does not populate the variant or the exclusive bit mask.
SetExclusiveBitMask
Builder & SetExclusiveBitMask(
uint64_t exclusive_bit_mask
)
A bit mask indicating exclusive roles for players.
(E.g. For example, if one player is the attacker, the other must be the defender.) Successful auto-matching requires that the logical product (AND) of the bit mask of any pairing players equals zero. Defaults to 0.
SetMaximumAutomatchingPlayers
Builder & SetMaximumAutomatchingPlayers(
uint32_t maximum_automatching_players
)
The maximum number of auto-matched players who can join the match.
Left unspecified, defaults to a value equal to the minimum number of auto-matching players.
SetMinimumAutomatchingPlayers
Builder & SetMinimumAutomatchingPlayers(
uint32_t minimum_automatching_players
)
The minimum number of auto-matched players who can join the match.
Defaults to 0 when left unspecified. At least one auto-matching player or player id must be added.
SetVariant
Builder & SetVariant(
uint32_t variant
)
A developer-specific value used to indicate match type or mode.
Only players using the same variant can auto-match. Defaults to -1 when left unspecified.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-10-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-28 UTC."],[],[],null,["# gpg::TurnBasedMatchConfig::Builder Class Reference\n\ngpg::TurnBasedMatchConfig::Builder\n==================================\n\n`#include \u003cturn_based_match_config_builder.h\u003e`\n\nBuilds one or more [TurnBasedMatchConfig](/games/services/cpp/api/class/gpg/turn-based-match-config#classgpg_1_1_turn_based_match_config) objects.\n\nSummary\n-------\n\n| ### Constructors and Destructors ||\n|---|---|\n| [Builder](#classgpg_1_1_turn_based_match_config_1_1_builder_1affc108da6d6df5b6b93a430eb1cdce62)`()` ||\n\n| ### Public functions ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [AddAllPlayersToInvite](#classgpg_1_1_turn_based_match_config_1_1_builder_1a1cc8b2b8ed3c4f61c73693a2deb3d5b8)`(const std::vector\u003c std::string \u003e & player_ids)` | [Builder](/games/services/cpp/api/class/gpg/turn-based-match-config/builder#classgpg_1_1_turn_based_match_config_1_1_builder)` &` Adds multiple players to the list of players to invite to the match. |\n| [AddPlayerToInvite](#classgpg_1_1_turn_based_match_config_1_1_builder_1af1d5ed0388dd5b7ad55981ba2cd9bba8)`(const std::string & player_id)` | [Builder](/games/services/cpp/api/class/gpg/turn-based-match-config/builder#classgpg_1_1_turn_based_match_config_1_1_builder)` &` Adds a player to the list of players to invite to the match. |\n| [Create](#classgpg_1_1_turn_based_match_config_1_1_builder_1af2aee232c43b6812e1698009623e5e0d)`() const ` | [TurnBasedMatchConfig](/games/services/cpp/api/class/gpg/turn-based-match-config#classgpg_1_1_turn_based_match_config) Creates a [TurnBasedMatchConfig](/games/services/cpp/api/class/gpg/turn-based-match-config#classgpg_1_1_turn_based_match_config) object. |\n| [PopulateFromPlayerSelectUIResponse](#classgpg_1_1_turn_based_match_config_1_1_builder_1a536f6294640adcece2ffe2fda600bdf7)`(const `[TurnBasedMultiplayerManager::PlayerSelectUIResponse](/games/services/cpp/api/struct/gpg/turn-based-multiplayer-manager/player-select-u-i-response#structgpg_1_1_turn_based_multiplayer_manager_1_1_player_select_u_i_response)` & response)` | [Builder](/games/services/cpp/api/class/gpg/turn-based-match-config/builder#classgpg_1_1_turn_based_match_config_1_1_builder)` &` Populates values from a `TurnBasedMultiplayerManager::ShowPlayerSelectUIResponse`. |\n| [SetExclusiveBitMask](#classgpg_1_1_turn_based_match_config_1_1_builder_1adda30366347a5880b899bebfc1ef3ef5)`(uint64_t exclusive_bit_mask)` | [Builder](/games/services/cpp/api/class/gpg/turn-based-match-config/builder#classgpg_1_1_turn_based_match_config_1_1_builder)` &` A bit mask indicating exclusive roles for players. |\n| [SetMaximumAutomatchingPlayers](#classgpg_1_1_turn_based_match_config_1_1_builder_1a9e43ded51cea29a4c75e0558d261e9b5)`(uint32_t maximum_automatching_players)` | [Builder](/games/services/cpp/api/class/gpg/turn-based-match-config/builder#classgpg_1_1_turn_based_match_config_1_1_builder)` &` The maximum number of auto-matched players who can join the match. |\n| [SetMinimumAutomatchingPlayers](#classgpg_1_1_turn_based_match_config_1_1_builder_1ad78accb39872ad02d911f4a0ff274553)`(uint32_t minimum_automatching_players)` | [Builder](/games/services/cpp/api/class/gpg/turn-based-match-config/builder#classgpg_1_1_turn_based_match_config_1_1_builder)` &` The minimum number of auto-matched players who can join the match. |\n| [SetVariant](#classgpg_1_1_turn_based_match_config_1_1_builder_1a16a8d9b77b16c3dc7bb723e4f5048987)`(uint32_t variant)` | [Builder](/games/services/cpp/api/class/gpg/turn-based-match-config/builder#classgpg_1_1_turn_based_match_config_1_1_builder)` &` A developer-specific value used to indicate match type or mode. |\n\nPublic functions\n----------------\n\n### AddAllPlayersToInvite\n\n```c++\nBuilder & AddAllPlayersToInvite(\n const std::vector\u003c std::string \u003e & player_ids\n)\n``` \nAdds multiple players to the list of players to invite to the match.\n\nBy default, no players are added. \n\n### AddPlayerToInvite\n\n```c++\nBuilder & AddPlayerToInvite(\n const std::string & player_id\n)\n``` \nAdds a player to the list of players to invite to the match.\n\nBy default, no players are added to the match. The builder cannot create a match until players are added. \n\n### Builder\n\n```c++\n Builder()\n``` \n\n### Create\n\n```c++\nTurnBasedMatchConfig Create() const \n``` \nCreates a [TurnBasedMatchConfig](/games/services/cpp/api/class/gpg/turn-based-match-config#classgpg_1_1_turn_based_match_config) object. \n\n### PopulateFromPlayerSelectUIResponse\n\n```c++\nBuilder & PopulateFromPlayerSelectUIResponse(\n const TurnBasedMultiplayerManager::PlayerSelectUIResponse & response\n)\n``` \nPopulates values from a `TurnBasedMultiplayerManager::ShowPlayerSelectUIResponse`.\n\nNote that this does not populate the variant or the exclusive bit mask. \n\n### SetExclusiveBitMask\n\n```c++\nBuilder & SetExclusiveBitMask(\n uint64_t exclusive_bit_mask\n)\n``` \nA bit mask indicating exclusive roles for players.\n\n(E.g. For example, if one player is the attacker, the other must be the defender.) Successful auto-matching requires that the logical product (AND) of the bit mask of any pairing players equals zero. Defaults to 0. \n\n### SetMaximumAutomatchingPlayers\n\n```c++\nBuilder & SetMaximumAutomatchingPlayers(\n uint32_t maximum_automatching_players\n)\n``` \nThe maximum number of auto-matched players who can join the match.\n\nLeft unspecified, defaults to a value equal to the minimum number of auto-matching players. \n\n### SetMinimumAutomatchingPlayers\n\n```c++\nBuilder & SetMinimumAutomatchingPlayers(\n uint32_t minimum_automatching_players\n)\n``` \nThe minimum number of auto-matched players who can join the match.\n\nDefaults to 0 when left unspecified. At least one auto-matching player or player id must be added. \n\n### SetVariant\n\n```c++\nBuilder & SetVariant(\n uint32_t variant\n)\n``` \nA developer-specific value used to indicate match type or mode.\n\nOnly players using the same variant can auto-match. Defaults to -1 when left unspecified."]]
