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