Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
IOnlineTurnBased - Interface class for turn based multiplayer matches
| Name | IOnlineTurnBased |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineTurnBasedInterface.h |
| Include Path | #include "Interfaces/OnlineTurnBasedInterface.h" |
Syntax
class IOnlineTurnBased
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IOnlineTurnBased() |
Interfaces/OnlineTurnBasedInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FTurnBasedEventDelegateWeakPtr GetEventDelegate() |
Interfaces/OnlineTurnBasedInterface.h | ||
virtual int32 GetMatchDataSize() |
The size of the game specific data stored per match. | Interfaces/OnlineTurnBasedInterface.h | |
virtual FTurnBasedMatchPtr GetMatchWithID
(
FString MatchID |
Returns the match object with the given MatchID. | Interfaces/OnlineTurnBasedInterface.h | |
virtual UObject * GetTurnBasedMatchInterfaceObject() |
Interfaces/OnlineTurnBasedInterface.h | ||
virtual void LoadAllMatches
(
FLoadTurnBasedMatchesSignature MatchesLoadedCallback |
Load all matches the current player is participating in. | Interfaces/OnlineTurnBasedInterface.h | |
virtual void LoadMatchWithID
(
FString MatchID, |
Reload a match with the given MatchID. | Interfaces/OnlineTurnBasedInterface.h | |
virtual void RegisterTurnBasedMatchInterfaceObject
(
UObject* Object |
Accessors referring to an object that inherits from UTurnBasedMatchInterface that acts like an FTurnBasedEventDelegate (needed for blueprints) | Interfaces/OnlineTurnBasedInterface.h | |
virtual void RemoveMatch
(
FTurnBasedMatchRef Match, |
Deletes a match entirely from the platform specific service. | Interfaces/OnlineTurnBasedInterface.h | |
virtual void SetEventDelegate
(
FTurnBasedEventDelegateWeakPtr Delegate |
Accessors for a delegate that gets called when match-specific events happen (such as the match ending or it is now the current players turn) | Interfaces/OnlineTurnBasedInterface.h | |
virtual void SetMatchmakerDelegate
(
FTurnBasedMatchmakerDelegatePtr Delegate |
Set a delegate to be called when matchmaking succeeds, fails, or is canceled. | Interfaces/OnlineTurnBasedInterface.h | |
virtual void ShowMatchmaker
(
const FTurnBasedMatchRequest& MatchRequest |
Show the platform specific matchmaker interface with the parameters given in FTurnBasedMatchRequest. | Interfaces/OnlineTurnBasedInterface.h |