gpg::TurnBasedMatch

#include <turn_based_match.h>

Es una estructura de datos que contiene datos sobre el estado actual de una TurnBasedMatch.

Resumen

Constructores y destructores
TurnBasedMatch()
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
Construye un TurnBasedMatch de un shared_ptr a un TurnBasedMatchImpl.
TurnBasedMatch(const TurnBasedMatch & copy_from)
Crea una copia de un TurnBasedMatch existente.
TurnBasedMatch(TurnBasedMatch && move_from)
Mueve un TurnBasedMatch existente.

Funciones públicas
AutomatchingSlotsAvailable() const
uint32_t
Muestra la cantidad de ranuras de coincidencia automática disponibles para la coincidencia.
CreatingParticipant() const
Muestra el participante que creó esta coincidencia.
CreationTime() const
std::chrono::milliseconds
Muestra la hora en la que se produjo este TurnBasedMatch was created (expresada en milisegundos desde la época de Unix).
Data() const
const std::vector< uint8_t > &
Muestra los datos de coincidencia si HasData() es verdadero.
Description() const
const std::string &
Devuelve un resumen generado por el servidor del estado de la coincidencia.
HasData() const
bool
Es verdadero si este objeto tiene datos que se establecieron durante un giro anterior.
HasPreviousMatchData() const
bool
Es verdadero si este es el primer turno de una revancha y los datos del Valid anterior deben mostrar un valor verdadero para que esta función se pueda usar.
HasRematchId() const
bool
Muestra verdadero si se volvió a realizar una coincidencia para este partido.
Id() const
const std::string &
Muestra un ID que identifica de forma única esta TurnBasedMatch.
LastUpdateTime() const
Muestra la hora en la que se actualizó por última vez este TurnBasedMatch (expresada en milisegundos desde la época Unix).
LastUpdatingParticipant() const
Muestra el participante que actualizó esta coincidencia más recientemente.
Number() const
uint32_t
Es un número que indica cuántas coincidencias precedieron a esta a través de la revancha.
ParticipantResults() const
Muestra los resultados de la coincidencia.
Participants() const
const std::vector< MultiplayerParticipant > &
Es un vector de todos los participantes de esta coincidencia.
PendingParticipant() const
Muestra el participante cuyo turno es actualizar esta coincidencia.
PreviousMatchData() const
const std::vector< uint8_t > &
Datos de la coincidencia anterior, si HasPreviousMatchData().
RematchId() const
const std::string &
Muestra el ID de la coincidencia que es una revancha de esta coincidencia, si está disponible.
Status() const
Muestra el estado de la coincidencia para el participante local.
SuggestedNextParticipant() const
Es una función auxiliar que elige un participante válido del conjunto de participantes unidos, invitables y de coincidencia automática.
Valid() const
bool
Muestra verdadero si este TurnBasedMatch se propaga con datos.
Variant() const
uint32_t
Muestra un identificador de variante específico del juego que puede usar un juego para identificar diferentes modos de juego.
Version() const
uint32_t
Es un ID que aumenta de forma estricta y se actualiza cada vez que se modifica una coincidencia.
operator=(const TurnBasedMatch & copy_from)
Asigna este TurnBasedMatch copiando de otro.
operator=(TurnBasedMatch && move_from)
Asigna este TurnBasedMatch moviendo otro dentro de él.

Funciones públicas

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const

Muestra la cantidad de ranuras de coincidencia automática disponibles para la coincidencia.

Esta cantidad es igual a la cantidad de espacios de coincidencia automática con los que se creó la coincidencia, menos la cantidad de participantes que ya se agregaron a través de la coincidencia automática. Valid debe mostrar verdadero para que esta función se pueda usar.

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const

Muestra el participante que creó esta coincidencia.

Valid debe mostrar verdadero para que esta función se pueda usar.

CreationTime

std::chrono::milliseconds CreationTime() const

Muestra la hora en la que se produjo este TurnBasedMatch was created (expresada en milisegundos desde la época de Unix).

Valid debe mostrar verdadero para que esta función se pueda usar.

Datos

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

Muestra los datos de coincidencia si HasData() es verdadero.

Valid debe mostrar verdadero para que esta función se pueda usar.

Descripción

const std::string & Description() const

Devuelve un resumen generado por el servidor del estado de la coincidencia.

Valid debe mostrar verdadero para que esta función se pueda usar.

HasData

bool HasData() const

Es verdadero si este objeto tiene datos que se establecieron durante un giro anterior.

Valid debe mostrar verdadero para que esta función se pueda usar.

HasPreviousMatchData

bool HasPreviousMatchData() const

Es verdadero si este es el primer turno de una revancha y los datos del Valid anterior deben mostrar un valor verdadero para que esta función se pueda usar.

HasRematchId

bool HasRematchId() const

Muestra verdadero si se volvió a realizar una coincidencia para este partido.

ID

const std::string & Id() const

Muestra un ID que identifica de forma única esta TurnBasedMatch.

Úsalo con TurnBasedMultiplayerManager::FetchMatch para recuperar esta coincidencia más adelante. Valid debe mostrar verdadero para que esta función se pueda usar.

LastUpdateTime

Timestamp LastUpdateTime() const

Muestra la hora en la que se actualizó por última vez este TurnBasedMatch (expresada en milisegundos desde la época Unix).

Valid debe mostrar verdadero para que esta función se pueda usar.

LastUpdatingParticipant

MultiplayerParticipant LastUpdatingParticipant() const

Muestra el participante que actualizó esta coincidencia más recientemente.

Valid debe mostrar verdadero para que esta función se pueda usar.

Número

uint32_t Number() const

Es un número que indica cuántas coincidencias precedieron a esta a través de la revancha.

Se establece en 1 en la primera coincidencia y aumenta en uno en cada nueva coincidencia.

ParticipantResults

const gpg::ParticipantResults & ParticipantResults() const

Muestra los resultados de la coincidencia.

Los resultados se pueden configurar a través de TurnBasedMultiplayerManager::TakeMyTurn, TurnBasedMultiplayerManager::FinishDuringMyTurn y otras funciones relacionadas. Siempre usa ParticipantResults().WithResult(...) para crear un objeto ParticipantResults nuevo que sea coherente con los existentes. Valid debe mostrar verdadero para que esta función se pueda usar.

Participantes

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

Es un vector de todos los participantes de esta coincidencia.

Valid debe mostrar verdadero para que esta función se pueda usar.

PendingParticipant

MultiplayerParticipant PendingParticipant() const

Muestra el participante cuyo turno es actualizar esta coincidencia.

Valid debe mostrar verdadero para que esta función se pueda usar.

PreviousMatchData

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

Datos de la coincidencia anterior, si HasPreviousMatchData().

Solo se puede llamar si Valid muestra un valor verdadero.

RematchId

const std::string & RematchId() const

Muestra el ID de la coincidencia que es una revancha de esta coincidencia, si está disponible.

Estado

MatchStatus Status() const

Muestra el estado de la coincidencia para el participante local.

El estado determina qué acciones se pueden realizar en la coincidencia. Valid debe mostrar verdadero para que esta función se pueda usar.

SuggestedNextParticipant

MultiplayerParticipant SuggestedNextParticipant() const

Es una función auxiliar que elige un participante válido del conjunto de participantes unidos, invitables y de coincidencia automática.

Si esta función siempre se usa para seleccionar al siguiente participante, el juego continuará con todos los participantes en orden y se repetirá si es necesario. Solo se debe llamar a esta función si Status() es MatchStatus::MY_TURN, ya que esta es la única vez que el resultado de esta función se puede usar de manera significativa. Si se llama de forma incorrecta, esta función mostrará un participante no válido (MultiplayerParticipant::Valid() == false).

TurnBasedMatch

 TurnBasedMatch()

TurnBasedMatch

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

Construye un TurnBasedMatch de un shared_ptr a un TurnBasedMatchImpl.

Está destinado al uso interno de la API.

TurnBasedMatch

 TurnBasedMatch(
  const TurnBasedMatch & copy_from
)

Crea una copia de un TurnBasedMatch existente.

TurnBasedMatch

 TurnBasedMatch(
  TurnBasedMatch && move_from
)

Mueve un TurnBasedMatch existente.

Válido

bool Valid() const

Muestra verdadero si este TurnBasedMatch se propaga con datos.

Debe mostrar verdadero para que se puedan usar las funciones de acceso en el objeto TurnBasedMatch (Id, CreationTime, etcétera).

Variant

uint32_t Variant() const

Muestra un identificador de variante específico del juego que puede usar un juego para identificar diferentes modos de juego.

Valid debe mostrar verdadero para que esta función se pueda usar.

Versión

uint32_t Version() const

Un ID que aumenta de forma estricta y se actualiza cada vez que se modifica una coincidencia.

operador=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

Asigna este TurnBasedMatch copiando de otro.

operador=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

Asigna este TurnBasedMatch moviendo otro dentro de él.