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)
|
|
TurnBasedMatch(const TurnBasedMatch & copy_from)
Crea una copia de un
TurnBasedMatch existente. |
|
TurnBasedMatch(TurnBasedMatch && move_from)
Mueve un elemento
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 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 de Valid anterior deben mostrar verdaderos para que esta función se pueda usar.
|
HasRematchId() const
|
bool
Muestra true si se volvió a encontrar esta coincidencia.
|
Id() const
|
const std::string &
Muestra un ID que identifica de forma exclusiva este
TurnBasedMatch . |
LastUpdateTime() const
|
Muestra la hora en la que se actualizó por última vez este
TurnBasedMatch (expresado como milisegundos desde el tiempo Unix). |
LastUpdatingParticipant() const
|
Muestra el participante que actualizó esta coincidencia más recientemente.
|
Number() const
|
uint32_t
Un número que indica cuántas coincidencias precedieron a esta por revancha.
|
ParticipantResults() const
|
const gpg::ParticipantResults &
Muestra los resultados de la coincidencia.
|
Participants() const
|
const std::vector< MultiplayerParticipant > &
Un vector de todos los participantes en esta partida.
|
PendingParticipant() const
|
Muestra al participante cuyo turno es actualizar esta coincidencia.
|
PreviousMatchData() const
|
const std::vector< uint8_t > &
Los datos de la coincidencia anterior, si HasPreviousMatchData().
|
RematchId() const
|
const std::string &
Muestra el ID de la coincidencia, que es una recoincidencia 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 elige a un participante válido del conjunto de participantes que se unen, invitan y que coinciden automáticamente.
|
Valid() const
|
bool
Muestra true si esta
TurnBasedMatch se propaga con datos. |
Variant() const
|
uint32_t
Muestra un identificador de variantes específico para un juego que este puede usar para identificar diferentes modos de juego.
|
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 de otro. |
operator=(TurnBasedMatch && move_from)
|
Mueve otro para asignar este
TurnBasedMatch . |
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 horarios disponibles con coincidencia automática con los que se creó la partida, menos la cantidad de participantes que ya se agregaron mediante la coincidencia automática. El valor Valid debe mostrar “true” para que se pueda usar esta función.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Muestra el participante que creó esta coincidencia.
El valor Valid debe mostrar “true” 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).
El valor Valid debe mostrar “true” para que se pueda usar esta función.
Datos
const std::vector< uint8_t > & Data() const
Descripción
const std::string & Description() const
Muestra un resumen generado por el servidor del estado de la coincidencia.
El valor Valid debe mostrar “true” para que se pueda usar esta función.
HasData
bool HasData() const
Es verdadero si este objeto tiene datos que se establecieron durante un giro anterior.
El valor Valid debe mostrar “true” para que se pueda usar esta función.
HasPreviousMatchData
bool HasPreviousMatchData() const
Es verdadero si este es el primer turno de una revancha, y los datos de Valid anterior deben mostrar verdaderos para que esta función se pueda usar.
HasRematchId
bool HasRematchId() const
Muestra true si se volvió a encontrar esta coincidencia.
ID
const std::string & Id() const
Muestra un ID que identifica de forma exclusiva este TurnBasedMatch
.
Úsala con TurnBasedMultiplayerManager::FetchMatch
para recuperar esta coincidencia más adelante. El valor Valid debe mostrar “true” para que se pueda usar esta función.
LastUpdateTime
Timestamp LastUpdateTime() const
Muestra la hora en la que se actualizó por última vez este TurnBasedMatch
(expresado como milisegundos desde el tiempo Unix).
El valor Valid debe mostrar “true” para que se pueda usar esta función.
LastUpdatingParticipant
MultiplayerParticipant LastUpdatingParticipant() const
Muestra el participante que actualizó esta coincidencia más recientemente.
El valor Valid debe mostrar “true” para que se pueda usar esta función.
Número
uint32_t Number() const
Un número que indica cuántas coincidencias precedieron a esta por 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. Usa siempre ParticipantResults().WithResult(...)
para crear un nuevo objeto ParticipantResults
coherente con los existentes. El valor Valid debe mostrar “true” para que se pueda usar esta función.
Participantes
const std::vector< MultiplayerParticipant > & Participants() const
Un vector de todos los participantes en esta partida.
El valor Valid debe mostrar “true” para que se pueda usar esta función.
PendingParticipant
MultiplayerParticipant PendingParticipant() const
Muestra al participante cuyo turno es actualizar esta coincidencia.
El valor Valid debe mostrar “true” para que se pueda usar esta función.
PreviousMatchData
const std::vector< uint8_t > & PreviousMatchData() const
Los 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 recoincidencia 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. El valor Valid debe mostrar “true” para que se pueda usar esta función.
SuggestedNextParticipant
MultiplayerParticipant SuggestedNextParticipant() const
Una función auxiliar que elige a un participante válido del conjunto de participantes que se unen, invitan y que coinciden automáticamente.
Si esta función siempre se usa para seleccionar al siguiente participante, el juego pasará 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 la 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
desde un shared_ptr
hasta un 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 elemento TurnBasedMatch
existente.
Válido
bool Valid() const
Muestra true si esta TurnBasedMatch
se propaga con datos.
El resultado debe ser verdadero para que se puedan usar las funciones del método get en el objeto TurnBasedMatch
(Id
, CreationTime
, etc.).
Variant
uint32_t Variant() const
Muestra un identificador de variantes específico para un juego que este puede usar para identificar diferentes modos de juego.
El valor Valid debe mostrar “true” 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.
operador=
TurnBasedMatch & operator=( const TurnBasedMatch & copy_from )
Asigna este TurnBasedMatch
copiando de otro.
operador=
TurnBasedMatch & operator=( TurnBasedMatch && move_from )
Mueve otro para asignar este TurnBasedMatch
.