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 shared_ptr a 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 este TurnBasedMatch was created (expresado en milisegundos desde el tiempo Unix).
Data() const
const std::vector< uint8_t > &
Muestra los datos de coincidencia si HasData() es verdadero.
Description() const
const std::string &
Muestra un resumen del estado de la coincidencia generado por el servidor.
HasData() const
bool
Es verdadero si este objeto tiene datos que se configuraron durante un giro anterior.
HasPreviousMatchData() const
bool
Es verdadero si es el primer turno de una revancha, y los datos del estado Valid anterior deben mostrar el valor "true" para que se pueda usar esta función.
HasRematchId() const
bool
El resultado es verdadero si se volvió a establecer esta coincidencia.
Id() const
const std::string &
Muestra un ID que identifica este TurnBasedMatch de forma exclusiva.
LastUpdateTime() const
Muestra la hora en la que este TurnBasedMatch se actualizó por última vez (expresado como milisegundos desde el tiempo 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 otra a través de la revancha.
ParticipantResults() const
Muestra los resultados de la coincidencia.
Participants() const
const std::vector< MultiplayerParticipant > &
Un vector de todos los participantes en esta coincidencia.
PendingParticipant() const
Muestra el participante cuyo turno es para 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
Una función auxiliar que selecciona a un participante válido del conjunto de participantes unidos, invitables y de coincidencia automática.
Valid() const
bool
Muestra true si este TurnBasedMatch se propaga con datos.
Variant() const
uint32_t
Devuelve un identificador de variantes específico del juego que puede usar un juego para identificar diferentes modos.
Version() const
uint32_t
Un ID que se incrementa estrictamente y que se actualiza cada vez que se modifica una coincidencia.
operator=(const TurnBasedMatch & copy_from)
Asigna este TurnBasedMatch copiando uno de otro.
operator=(TurnBasedMatch && move_from)
Asigna este TurnBasedMatch moviendo otro.

Funciones públicas

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const

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

Este número es igual a la cantidad de horarios disponibles de coincidencia automática con los que se creó la coincidencia, menos la cantidad de participantes que ya se agregaron mediante la coincidencia automática. Valid debe mostrar verdadero para que se pueda usar esta función.

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const

Muestra el participante que creó esta coincidencia.

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

CreationTime

std::chrono::milliseconds CreationTime() const

Muestra la hora en la que este TurnBasedMatch was created (expresado en milisegundos desde el tiempo Unix).

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

Datos

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

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

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

Descripción

const std::string & Description() const

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

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

HasData

bool HasData() const

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

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

HasPreviousMatchData

bool HasPreviousMatchData() const

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

HasRematchId

bool HasRematchId() const

El resultado es verdadero si se volvió a establecer esta coincidencia.

ID

const std::string & Id() const

Muestra un ID que identifica este TurnBasedMatch de forma exclusiva.

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

LastUpdateTime

Timestamp LastUpdateTime() const

Muestra la hora en la que este TurnBasedMatch se actualizó por última vez (expresado como milisegundos desde el tiempo Unix).

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

LastUpdatingParticipant

MultiplayerParticipant LastUpdatingParticipant() const

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

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

Número

uint32_t Number() const

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

Se establece en 1 en la primera partida y se incrementa en uno en cada revancha.

ParticipantResults

const gpg::ParticipantResults & ParticipantResults() const

Muestra los resultados de la coincidencia.

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

Participantes

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

Un vector de todos los participantes en esta coincidencia.

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

PendingParticipant

MultiplayerParticipant PendingParticipant() const

Muestra el participante cuyo turno es para actualizar esta coincidencia.

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

PreviousMatchData

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

Datos de la coincidencia anterior, si HasPreviousMatchData().

Solo se puede llamar si Valid muestra 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 se pueda usar esta función.

SuggestedNextParticipant

MultiplayerParticipant SuggestedNextParticipant() const

Una función auxiliar que selecciona a un participante válido del conjunto de participantes unidos, invitables y de coincidencia automática.

Si esta función siempre se utiliza para seleccionar al siguiente participante, la reproducción avanzará por 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 en 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 shared_ptr a TurnBasedMatchImpl.

Diseñado para el 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 true si este TurnBasedMatch se propaga con datos.

Debe mostrar el valor "true" para que las funciones del método get en el objeto TurnBasedMatch (Id, CreationTime, etc.) se puedan usar.

Variante

uint32_t Variant() const

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

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

Versión

uint32_t Version() const

Un ID que se incrementa estrictamente y que se actualiza cada vez que se modifica una coincidencia.

operator=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

Asigna este TurnBasedMatch copiando uno de otro.

operator=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

Asigna este TurnBasedMatch moviendo otro.