gpg::TurnBasedMatch

#include <turn_based_match.h>

Struktura danych zawierająca informacje o bieżącym stanie elementu TurnBasedMatch.

Podsumowanie

Konstruktory i niszczyciele
TurnBasedMatch()
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
Konstruuje TurnBasedMatch od shared_ptr do TurnBasedMatchImpl.
TurnBasedMatch(const TurnBasedMatch & copy_from)
Tworzy kopię istniejącego elementu TurnBasedMatch.
TurnBasedMatch(TurnBasedMatch && move_from)
Przenosi dotychczasowy TurnBasedMatch.

Funkcje publiczne
AutomatchingSlotsAvailable() const
uint32_t
Zwraca liczbę dostępnych przedziałów automatycznie dopasowanych dla danego dopasowania.
CreatingParticipant() const
Zwraca uczestnika, który utworzył tę grę.
CreationTime() const
std::chrono::milliseconds
Zwraca czas wystąpienia funkcji TurnBasedMatch was created (wyrażony w milisekundach od początku epoki uniksowej).
Data() const
const std::vector< uint8_t > &
Zwraca dane dopasowania, jeśli HasData() ma wartość prawda.
Description() const
const std::string &
Zwraca wygenerowane przez serwer podsumowanie stanu dopasowania.
HasData() const
bool
Prawda, jeśli obiekt zawiera dane ustawione podczas poprzedniej tury.
HasPreviousMatchData() const
bool
Ma wartość Prawda, jeśli jest to pierwszy etap rewanżu. Aby można było używać tej funkcji, dane z poprzedniej wartości Valid muszą zwrócić wartość „prawda”.
HasRematchId() const
bool
Zwraca wartość prawda, jeśli to dopasowanie zostało ponownie dopasowane.
Id() const
const std::string &
Zwraca identyfikator, który jednoznacznie identyfikuje TurnBasedMatch.
LastUpdateTime() const
Zwraca czas ostatniej aktualizacji obiektu TurnBasedMatch (wyrażony w milisekundach od początku epoki uniksowej).
LastUpdatingParticipant() const
Zwraca uczestnika, który ostatnio zaktualizował dopasowanie.
Number() const
uint32_t
Liczba wskazująca, ile dopasowań poprzedziło tę regułę przez ponowne dopasowanie.
ParticipantResults() const
Zwraca wyniki dla danego dopasowania.
Participants() const
const std::vector< MultiplayerParticipant > &
Wektor wszystkich uczestników tego meczu.
PendingParticipant() const
Zwraca uczestnika, którego kolej na zaktualizowanie gry.
PreviousMatchData() const
const std::vector< uint8_t > &
Dane z poprzedniego dopasowania, jeśli HasPreviousMatchData().
RematchId() const
const std::string &
Zwraca identyfikator dopasowania, które stanowi rewanżę tego dopasowania (jeśli jest dostępna).
Status() const
Zwraca stan dopasowania dla uczestnika lokalnego.
SuggestedNextParticipant() const
Funkcja pomocnicza, która wybiera prawidłowego uczestnika ze zbioru uczestników dołączonych, niezaproszeni i automatycznie dopasowanych.
Valid() const
bool
Zwraca wartość „prawda”, jeśli w elemencie TurnBasedMatch znajdują się dane.
Variant() const
uint32_t
Zwraca identyfikator wariantu gry, który może służyć do identyfikowania różnych trybów gry.
Version() const
uint32_t
Identyfikator ściśle zwiększający się, aktualizowany za każdym razem, gdy dopasowanie jest modyfikowane.
operator=(const TurnBasedMatch & copy_from)
Przypisuje ten element (TurnBasedMatch), kopiując go z innego elementu.
operator=(TurnBasedMatch && move_from)
Przypisuje ten element typu TurnBasedMatch, przenosząc do niego inny.

Funkcje publiczne

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const

Zwraca liczbę dostępnych przedziałów automatycznie dopasowanych dla danego dopasowania.

Liczba ta jest równa liczbie przedziałów automatycznego dopasowywania, z którymi utworzono dopasowanie, pomniejszoną o liczbę uczestników, którzy zostali już dodani za pomocą funkcji automatycznego dopasowywania. Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const

Zwraca uczestnika, który utworzył tę grę.

Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

CreationTime

std::chrono::milliseconds CreationTime() const

Zwraca czas wystąpienia funkcji TurnBasedMatch was created (wyrażony w milisekundach od początku epoki uniksowej).

Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

Dane

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

Zwraca dane dopasowania, jeśli HasData() ma wartość prawda.

Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

Opis

const std::string & Description() const

Zwraca wygenerowane przez serwer podsumowanie stanu dopasowania.

Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

HasData

bool HasData() const

Prawda, jeśli obiekt zawiera dane ustawione podczas poprzedniej tury.

Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

HasPreviousMatchData

bool HasPreviousMatchData() const

Ma wartość Prawda, jeśli jest to pierwszy etap rewanżu. Aby można było używać tej funkcji, dane z poprzedniej wartości Valid muszą zwrócić wartość „prawda”.

HasRematchId

bool HasRematchId() const

Zwraca wartość prawda, jeśli to dopasowanie zostało ponownie dopasowane.

Identyfikator

const std::string & Id() const

Zwraca identyfikator, który jednoznacznie identyfikuje TurnBasedMatch.

Użyj razem z TurnBasedMultiplayerManager::FetchMatch, aby pobrać to dopasowanie później. Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

LastUpdateTime

Timestamp LastUpdateTime() const

Zwraca czas ostatniej aktualizacji obiektu TurnBasedMatch (wyrażony w milisekundach od początku epoki uniksowej).

Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

LastUpdatingParticipant

MultiplayerParticipant LastUpdatingParticipant() const

Zwraca uczestnika, który ostatnio zaktualizował dopasowanie.

Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

Liczba

uint32_t Number() const

Liczba wskazująca, ile dopasowań poprzedziło tę regułę przez ponowne dopasowanie.

jest ustawiany na 1 przy pierwszym meczu i zwiększany o jeden przy każdym rewanżu.

ParticipantResults

const gpg::ParticipantResults & ParticipantResults() const

Zwraca wyniki dla danego dopasowania.

Wyniki można ustawić za pomocą funkcji TurnBasedMultiplayerManager::TakeMyTurn, TurnBasedMultiplayerManager::FinishDuringMyTurn i innych powiązanych funkcji. Zawsze używaj funkcji ParticipantResults().WithResult(...) do utworzenia nowego obiektu ParticipantResults, który będzie spójny z istniejącymi obiektami. Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

Uczestnicy

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

Wektor wszystkich uczestników tego meczu.

Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

PendingParticipant

MultiplayerParticipant PendingParticipant() const

Zwraca uczestnika, którego kolej na zaktualizowanie gry.

Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

PreviousMatchData

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

Dane z poprzedniego dopasowania, jeśli HasPreviousMatchData().

Można ją wywołać tylko wtedy, gdy zasada Valid zwraca wartość „prawda”.

RematchId

const std::string & RematchId() const

Zwraca identyfikator dopasowania, które stanowi rewanżę tego dopasowania (jeśli jest dostępna).

Stan

MatchStatus Status() const

Zwraca stan dopasowania dla uczestnika lokalnego.

Stan określa, jakie działania można podjąć w związku z dopasowaniem. Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

SuggestedNextParticipant

MultiplayerParticipant SuggestedNextParticipant() const

Funkcja pomocnicza, która wybiera prawidłowego uczestnika ze zbioru uczestników dołączonych, niezaproszeni i automatycznie dopasowanych.

Jeśli ta funkcja jest zawsze używana do wybierania kolejnego uczestnika, rozgrywka odbywa się po kolei przez wszystkich uczestników. W razie potrzeby powtórz ją. Tę funkcję można wywołać tylko wtedy, gdy Status() ma wartość MatchStatus::MY_TURN, ponieważ jest to jedyny raz, kiedy wynik tej funkcji może być użyteczny. Jeśli ta funkcja zostanie wywołana nieprawidłowo, zwróci nieprawidłowego uczestnika (MultiplayerParticipant::Valid() == false).

TurnBasedMatch

 TurnBasedMatch()

TurnBasedMatch

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

Konstruuje TurnBasedMatch od shared_ptr do TurnBasedMatchImpl.

Przeznaczony do użytku wewnętrznego w interfejsie API.

TurnBasedMatch

 TurnBasedMatch(
  const TurnBasedMatch & copy_from
)

Tworzy kopię istniejącego elementu TurnBasedMatch.

TurnBasedMatch

 TurnBasedMatch(
  TurnBasedMatch && move_from
)

Przenosi dotychczasowy TurnBasedMatch.

Prawidłowe

bool Valid() const

Zwraca wartość „prawda”, jeśli w elemencie TurnBasedMatch znajdują się dane.

Aby funkcje pobierania w obiekcie TurnBasedMatch (Id, CreationTime itd.) mogły być użyte, musi zwracać wartość „true” (prawda).

Wariant

uint32_t Variant() const

Zwraca identyfikator wariantu gry, który może służyć do identyfikowania różnych trybów gry.

Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).

Wersja

uint32_t Version() const

Identyfikator ściśle zwiększający się, aktualizowany za każdym razem, gdy dopasowanie jest modyfikowane.

operator=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

Przypisuje ten element (TurnBasedMatch), kopiując go z innego elementu.

operator=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

Przypisuje ten element typu TurnBasedMatch, przenosząc do niego inny.