гпг:: Пошаговый матч

#include <turn_based_match.h>

Структура данных, содержащая данные о текущем состоянии TurnBasedMatch .

Краткое содержание

Конструкторы и деструкторы

TurnBasedMatch ()
TurnBasedMatch (std::shared_ptr< const TurnBasedMatchImpl > impl)
Создает TurnBasedMatch из shared_ptr в TurnBasedMatchImpl .
TurnBasedMatch (const TurnBasedMatch & copy_from)
Создает копию существующего TurnBasedMatch .
TurnBasedMatch ( TurnBasedMatch && move_from)
Перемещает существующий TurnBasedMatch .

Общественные функции

AutomatchingSlotsAvailable () const
uint32_t
Возвращает количество доступных слотов автоматического соответствия для совпадения.
CreatingParticipant () const
Возвращает участника, создавшего это совпадение.
CreationTime () const
std::chrono::milliseconds
Возвращает время TurnBasedMatch was created (выраженное в миллисекундах с эпохи Unix).
Data () const
const std::vector< uint8_t > &
Возвращает данные совпадения, если HasData() имеет значение true.
Description () const
const std::string &
Возвращает сгенерированную сервером сводку состояния совпадения.
HasData () const
bool
Истинно, если этот объект имеет данные, которые были установлены во время предыдущего хода.
HasPreviousMatchData () const
bool
True, если это первый ход матча-реванша, и данные предыдущего Valid должны возвращать true, чтобы эту функцию можно было использовать.
HasRematchId () const
bool
Возвращает true, если это совпадение было сопоставлено повторно.
Id () const
const std::string &
Возвращает идентификатор, который уникально идентифицирует этот TurnBasedMatch .
LastUpdateTime () const
Возвращает время последнего обновления TurnBasedMatch (выраженное в миллисекундах с эпохи Unix).
LastUpdatingParticipant () const
Возвращает участника, который последним обновил это совпадение.
Number () const
uint32_t
Число, указывающее, сколько матчей предшествовало этому повторному совпадению.
ParticipantResults () const
Возвращает результаты матча.
Participants () const
const std::vector< MultiplayerParticipant > &
Вектор всех участников этого матча.
PendingParticipant () const
Возвращает участника, чья очередь обновить это совпадение.
PreviousMatchData () const
const std::vector< uint8_t > &
Данные предыдущего совпадения, если HasPreviousMatchData() .
RematchId () const
const std::string &
Возвращает идентификатор матча, который является повтором этого матча, если он доступен.
Status () const
Возвращает статус матча для локального участника.
SuggestedNextParticipant () const
Вспомогательная функция, которая выбирает допустимого участника из набора присоединившихся, приглашенных и автоматически подходящих участников.
Valid () const
bool
Возвращает true, если TurnBasedMatch заполнен данными.
Variant () const
uint32_t
Возвращает идентификатор варианта игры, который может использоваться игрой для идентификации различных игровых режимов.
Version () const
uint32_t
Строго увеличивающийся идентификатор, обновляемый каждый раз при изменении соответствия.
operator= (const TurnBasedMatch & copy_from)
Назначает этот TurnBasedMatch путем копирования из другого.
operator= ( TurnBasedMatch && move_from)
Назначает этот TurnBasedMatch , перемещая в него другой.

Общественные функции

Автоматическое сопоставление слотовДоступно

uint32_t AutomatchingSlotsAvailable() const

Возвращает количество доступных слотов автоматического соответствия для совпадения.

Это число равно количеству слотов автоматического сопоставления, с которыми было создано совпадение, за вычетом количества участников, которые уже были добавлены посредством автоматического сопоставления. Valid должен возвращать true, чтобы эту функцию можно было использовать.

Создание участника

MultiplayerParticipant CreatingParticipant() const

Возвращает участника, создавшего это совпадение.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Время создания

std::chrono::milliseconds CreationTime() const

Возвращает время TurnBasedMatch was created (выраженное в миллисекундах с эпохи Unix).

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Данные

const std::vector< uint8_t > & Data() const

Возвращает данные совпадения, если HasData() имеет значение true.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Описание

const std::string & Description() const

Возвращает сгенерированную сервером сводку состояния совпадения.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Хасдата

bool HasData() const

Истинно, если этот объект имеет данные, которые были установлены во время предыдущего хода.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

HasPreviousMatchData

bool HasPreviousMatchData() const

True, если это первый ход матча-реванша, и данные предыдущего Valid должны возвращать true, чтобы эту функцию можно было использовать.

HasRematchId

bool HasRematchId() const

Возвращает true, если это совпадение было сопоставлено повторно.

Идентификатор

const std::string & Id() const

Возвращает идентификатор, который уникально идентифицирует этот TurnBasedMatch .

Используйте с TurnBasedMultiplayerManager::FetchMatch , чтобы получить это совпадение позднее. Valid должен возвращать true, чтобы эту функцию можно было использовать.

Ластапдатетиме

Timestamp LastUpdateTime() const

Возвращает время последнего обновления TurnBasedMatch (выраженное в миллисекундах с эпохи Unix).

Valid должен возвращать true, чтобы эту функцию можно было использовать.

ПоследнийОбновлениеУчастник

MultiplayerParticipant LastUpdatingParticipant() const

Возвращает участника, который последним обновил это совпадение.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Число

uint32_t Number() const

Число, указывающее, сколько матчей предшествовало этому повторному совпадению.

Устанавливается на 1 в первом матче и увеличивается на единицу при каждом матче-реванше.

Результаты участника

const gpg::ParticipantResults & ParticipantResults() const

Возвращает результаты матча.

Результаты можно установить с помощью TurnBasedMultiplayerManager::TakeMyTurn , TurnBasedMultiplayerManager::FinishDuringMyTurn и других связанных функций. Всегда используйте ParticipantResults() .WithResult(...) для создания нового объекта ParticipantResults , соответствующего всем существующим. Valid должен возвращать true, чтобы эту функцию можно было использовать.

Участники

const std::vector< MultiplayerParticipant > & Participants() const

Вектор всех участников этого матча.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Ожидается участник

MultiplayerParticipant PendingParticipant() const

Возвращает участника, чья очередь обновить это совпадение.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

ПредыдущиеДанные Матча

const std::vector< uint8_t > & PreviousMatchData() const

Данные предыдущего совпадения, если HasPreviousMatchData() .

Может быть вызван только в том случае, если Valid возвращает true.

Ид повторного матча

const std::string & RematchId() const

Возвращает идентификатор матча, который является повтором этого матча, если он доступен.

Положение дел

MatchStatus Status() const

Возвращает статус матча для локального участника.

Статус определяет, какие действия можно предпринять в ходе матча. Valid должен возвращать true, чтобы эту функцию можно было использовать.

ПредложеноСледующийУчастник

MultiplayerParticipant SuggestedNextParticipant() const

Вспомогательная функция, которая выбирает допустимого участника из набора присоединившихся, приглашенных и автоматически подходящих участников.

Если эта функция всегда используется для выбора следующего участника, игра будет проходить по всем участникам по порядку, повторяясь при необходимости. Эту функцию следует вызывать только в том случае, если Status() имеет значение MatchStatus::MY_TURN , поскольку это единственный раз, когда результат этой функции может быть осмысленно использован. При неправильном вызове эта функция вернет недопустимого участника ( MultiplayerParticipant::Valid() == false ).

Пошаговый матч

 TurnBasedMatch()

Пошаговый матч

 TurnBasedMatch(
  std::shared_ptr< const TurnBasedMatchImpl > impl
)

Создает TurnBasedMatch из shared_ptr в TurnBasedMatchImpl .

Предназначен для внутреннего использования API.

Пошаговый матч

 TurnBasedMatch(
  const TurnBasedMatch & copy_from
)

Создает копию существующего TurnBasedMatch .

Пошаговый матч

 TurnBasedMatch(
  TurnBasedMatch && move_from
)

Перемещает существующий TurnBasedMatch .

Действительный

bool Valid() const

Возвращает true, если TurnBasedMatch заполнен данными.

Должен возвращать true, чтобы функции получения объекта TurnBasedMatch ( Id , CreationTime и т. д.) можно было использовать.

Вариант

uint32_t Variant() const

Возвращает идентификатор варианта игры, который может использоваться игрой для идентификации различных игровых режимов.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Версия

uint32_t Version() const

Строго увеличивающийся идентификатор, обновляемый каждый раз при изменении соответствия.

оператор=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

Назначает этот TurnBasedMatch путем копирования из другого.

оператор=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

Назначает этот TurnBasedMatch , перемещая в него другой.