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 IOnlineTurnBased
Remarks
IOnlineTurnBased - Interface class for turn based multiplayer matches
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
FTurnBasedEventDelegateWeakPtr | ||
  |
int32 | The size of the game specific data stored per match. | |
   |
FTurnBasedMatchPtr | GetMatchWithID
(
FString MatchID |
Returns the match object with the given MatchID. |
  |
UObject * | ||
  |
void | LoadAllMatches
(
FLoadTurnBasedMatchesSignature MatchesLoadedCallback |
Load all matches the current player is participating in. |
  |
void | LoadMatchWithID
(
FString MatchID, |
Reload a match with the given MatchID. |
  |
void | RegisterTurnBasedMatchInterfaceObject
(
UObject* Object |
Accessors referring to an object that inherits from UTurnBasedMatchInterface that acts like an FTurnBasedEventDelegate (needed for blueprints) |
  |
void | RemoveMatch
(
FTurnBasedMatchRef Match, |
Deletes a match entirely from the platform specific service. |
  |
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) |
  |
void | SetMatchmakerDelegate
(
FTurnBasedMatchmakerDelegatePtr Delegate |
Set a delegate to be called when matchmaking succeeds, fails, or is canceled. |
  |
void | ShowMatchmaker
(
const FTurnBasedMatchRequest& MatchRequest |
Show the platform specific matchmaker interface with the parameters given in FTurnBasedMatchRequest. |