gpg:: TurnBasedMatch
#include <turn_based_match.h>
Struktura danych zawierająca informacje o bieżącym stanie elementu TurnBasedMatch
.
Podsumowanie
Konstruktorzy i niszczyciele |
|
---|---|
TurnBasedMatch()
|
|
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
|
|
TurnBasedMatch(const TurnBasedMatch & copy_from)
Tworzy kopię istniejącego elementu
TurnBasedMatch . |
|
TurnBasedMatch(TurnBasedMatch && move_from)
Przenosi istniejące urządzenie
TurnBasedMatch . |
Funkcje publiczne |
|
---|---|
AutomatchingSlotsAvailable() const
|
uint32_t
Zwraca liczbę dostępnych przedziałów dla dopasowania automatycznego.
|
CreatingParticipant() const
|
Zwraca uczestnika, który utworzył dopasowanie.
|
CreationTime() const
|
std::chrono::milliseconds
Zwraca czas
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 ten obiekt ma dane ustawione podczas poprzedniego zakrętu.
|
HasPreviousMatchData() const
|
bool
Prawda, jeśli jest to pierwszy zakręt ponownego dopasowania. Aby można było użyć tej funkcji, dane z poprzedniej właściwości Valid muszą zwracać wartość „prawda”.
|
HasRematchId() const
|
bool
Zwraca wartość „prawda”, jeśli to dopasowanie zostało ponownie dopasowane.
|
Id() const
|
const std::string &
Zwraca unikalny identyfikator elementu
TurnBasedMatch . |
LastUpdateTime() const
|
Zwraca czas ostatniej aktualizacji obiektu
TurnBasedMatch (wyrażony w milisekundach od początku uniksowego okresu). |
LastUpdatingParticipant() const
|
Zwraca uczestnika, który ostatnio zaktualizował ten wynik.
|
Number() const
|
uint32_t
Liczba określająca, ile dopasowań poprzedziło tę liczbę przez ponowne dopasowanie.
|
ParticipantResults() const
|
const gpg::ParticipantResults &
Zwraca wyniki dopasowania.
|
Participants() const
|
const std::vector< MultiplayerParticipant > &
Wektor wszystkich uczestników tego meczu.
|
PendingParticipant() const
|
Zwraca uczestnika, którego kolejka ma zaktualizować to dopasowanie.
|
PreviousMatchData() const
|
const std::vector< uint8_t > &
Dane z poprzedniego dopasowania, jeśli HasPreviousMatchData().
|
RematchId() const
|
const std::string &
Zwraca identyfikator dopasowania, które jest rewanżem tego dopasowania (jeśli jest dostępne).
|
Status() const
|
Zwraca stan dopasowania do uczestnika lokalnego.
|
SuggestedNextParticipant() const
|
Funkcja pomocnicza, która wybiera prawidłowego uczestnika z grupy dołączonych, nieuniknionych i automatycznie dopasowanych uczestników.
|
Valid() const
|
bool
Zwraca wartość „prawda”, jeśli pole
TurnBasedMatch zawiera dane. |
Variant() const
|
uint32_t
Zwraca identyfikator wariantu gry, którego może używać do identyfikowania różnych trybów gry.
|
Version() const
|
uint32_t
Ciągle rosnący identyfikator aktualizowany za każdym razem, gdy dopasowanie następuje.
|
operator=(const TurnBasedMatch & copy_from)
|
Przypisuje ten element
TurnBasedMatch , kopiując go z innego elementu. |
operator=(TurnBasedMatch && move_from)
|
Przypisuje element
TurnBasedMatch , przenosząc do niego inny. |
Funkcje publiczne
AutomatchingSlotsAvailable
uint32_t AutomatchingSlotsAvailable() const
Zwraca liczbę dostępnych przedziałów dla dopasowania automatycznego.
Ta liczba jest równa liczbie przedziałów, w których dopasowano grę, pomniejszonej o liczbę uczestników, którzy zostali już dodani w wyniku automatycznego dopasowywania. Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Zwraca uczestnika, który utworzył dopasowanie.
Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
CreationTime
std::chrono::milliseconds CreationTime() const
Zwraca czas TurnBasedMatch was created
(wyrażony w milisekundach od początku epoki uniksowej).
Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
Dane
const std::vector< uint8_t > & Data() const
Opis
const std::string & Description() const
Zwraca wygenerowane przez serwer podsumowanie stanu dopasowania.
Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
HasData
bool HasData() const
Prawda, jeśli ten obiekt ma dane ustawione podczas poprzedniego zakrętu.
Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
HasPreviousMatchData
bool HasPreviousMatchData() const
Prawda, jeśli jest to pierwszy zakręt ponownego dopasowania. Aby można było użyć tej funkcji, dane z poprzedniej właściwości Valid muszą zwracać wartość „prawda”.
HasRematchId
bool HasRematchId() const
Zwraca wartość „prawda”, jeśli to dopasowanie zostało ponownie dopasowane.
Identyfikator
const std::string & Id() const
Zwraca unikalny identyfikator elementu TurnBasedMatch
.
Aby później odzyskać dopasowanie, użyj funkcji TurnBasedMultiplayerManager::FetchMatch
. Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
LastUpdateTime
Timestamp LastUpdateTime() const
Zwraca czas ostatniej aktualizacji obiektu TurnBasedMatch
(wyrażony w milisekundach od początku uniksowego okresu).
Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
LastUpdatingParticipant
MultiplayerParticipant LastUpdatingParticipant() const
Zwraca uczestnika, który ostatnio zaktualizował ten wynik.
Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
Liczby
uint32_t Number() const
Liczba określająca, ile dopasowań poprzedziło tę liczbę przez ponowne dopasowanie.
Ma wartość 1 w pierwszym meczu i zwiększa się o 1 przy każdym rewanżu.
ParticipantResults
const gpg::ParticipantResults & ParticipantResults() const
Zwraca wyniki dopasowania.
Wyniki można ustawiać za pomocą funkcji TurnBasedMultiplayerManager::TakeMyTurn
, TurnBasedMultiplayerManager::FinishDuringMyTurn
i innych powiązanych funkcji. Zawsze używaj polecenia ParticipantResults().WithResult(...)
do tworzenia nowych obiektów ParticipantResults
spójnych z istniejącymi. Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
uczestników
const std::vector< MultiplayerParticipant > & Participants() const
Wektor wszystkich uczestników tego meczu.
Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
PendingParticipant
MultiplayerParticipant PendingParticipant() const
Zwraca uczestnika, którego kolejka ma zaktualizować to dopasowanie.
Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
PreviousMatchData
const std::vector< uint8_t > & PreviousMatchData() const
Dane z poprzedniego dopasowania, jeśli HasPreviousMatchData().
Można ją wywoływać tylko wtedy, gdy funkcja Valid zwraca wartość „true” (prawda).
RematchId
const std::string & RematchId() const
Zwraca identyfikator dopasowania, które jest rewanżem tego dopasowania (jeśli jest dostępne).
Stan
MatchStatus Status() const
Zwraca stan dopasowania do uczestnika lokalnego.
Stan określa, jakie działania można podjąć w przypadku dopasowania. Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
SuggestedNextParticipant
MultiplayerParticipant SuggestedNextParticipant() const
Funkcja pomocnicza, która wybiera prawidłowego uczestnika z grupy dołączonych, nieuniknionych i automatycznie dopasowanych uczestników.
Jeśli ta funkcja jest zawsze używana do wybierania kolejnego uczestnika, gra będzie kontynuowana po kolei przez wszystkich uczestników, w razie potrzeby powtarzając tę czynność. Funkcję tę można wywołać tylko wtedy, gdy funkcja Status() ma wartość MatchStatus::MY_TURN, ponieważ jest to jedyny raz, w którym można jednoznacznie użyć wyniku tej funkcji. Jeśli 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
z shared_ptr
na TurnBasedMatchImpl
.
Przeznaczona do użytku wewnętrznego przez interfejs API.
TurnBasedMatch
TurnBasedMatch( const TurnBasedMatch & copy_from )
Tworzy kopię istniejącego elementu TurnBasedMatch
.
TurnBasedMatch
TurnBasedMatch( TurnBasedMatch && move_from )
Przenosi istniejące urządzenie TurnBasedMatch
.
Prawidłowy
bool Valid() const
Zwraca wartość „prawda”, jeśli pole TurnBasedMatch
zawiera dane.
Aby można było użyć funkcji pobierania w obiekcie TurnBasedMatch
(Id
, CreationTime
itd.), musi ona zwracać wartość „true” (prawda).
Wariant
uint32_t Variant() const
Zwraca identyfikator wariantu gry, którego może używać do identyfikowania różnych trybów gry.
Aby można było użyć tej funkcji, argument Valid musi zwracać wartość „prawda”.
Wersja
uint32_t Version() const
Ciągle rosnący identyfikator aktualizowany za każdym razem, gdy dopasowanie następuje.
operator=
TurnBasedMatch & operator=( const TurnBasedMatch & copy_from )
Przypisuje ten element TurnBasedMatch
, kopiując go z innego elementu.
operator=
TurnBasedMatch & operator=( TurnBasedMatch && move_from )
Przypisuje element TurnBasedMatch
, przenosząc do niego inny.