Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces
References
| Module | OnlineSubsystem |
| Header | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineTurnBasedInterface.h |
| Include | #include "Interfaces/OnlineTurnBasedInterface.h" |
Syntax
class FTurnBasedMatch
Remarks
FTurnBasedMatch contains all of the information about an in-progress turn based match
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | EndMatch
(
FEndMatchSignature QuitMatchCallback, |
Ends the match while setting the match outcome (win/loss/tie) for all players |
  |
void | EndTurnWithMatchData
(
const TArray< uint8 >& MatchData, |
End the turn and upload MatchData. |
   |
int32 | Get the index of the current player in the match's list of participants | |
   |
int32 | Get the index of the local player in the match's list of participants | |
   |
bool | GetMatchData
(
TArray< uint8 >& OutMatchData |
Put the match data into OutMatchData, returning whether or not the operation was successful |
   |
FString | GetMatchID () |
Returns the Match ID for this match |
   |
EMPMatchOutcome::Outcome | GetMatchOutcomeForPlayer
(
int32 PlayerIndex |
Get the outcome of the match (won/lost/quit/etc.) for the player with PlayerIndex |
   |
int32 | Get the number of players in the match | |
   |
bool | GetPlayerDisplayName
(
int32 PlayerIndex, |
Get the user-friendly display name for the given player. |
   |
bool | HasMatchData () |
HasMatchData is for when you want to know if the match has data, without getting at the data |
  |
void | QuitMatch
(
EMPMatchOutcome::Outcome Outcome, |
Leave the match, providing an outcome for the player |
  |
void | ReloadMatchData
(
FDownloadMatchDataSignature DownloadCallback |
Request a reload of the match's data. |
  |
void | SetMatchData
(
const TArray< uint8 >& NewMatchData, |
Update the data for the match with the data provided |