Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

IOnlineTurnBased

[IOnlineTurnBased](API\Plugins\OnlineSubsystem\Interfaces\IOnlineTurnBased) - Interface class for turn based multiplayer matches

Windows

MacOS

Linux

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

	Name	Description
	~IOnlineTurnBased()

Functions

	Name	Description
FTurnBasedEv...	GetEventDelegate()
int32	GetMatchDataSize()	The size of the game specific data stored per match.
FTurnBasedMa...	GetMatchWithID ( FString MatchID )	Returns the match object with the given MatchID.
UObject *...	GetTurnBasedMatchInterfaceObject()
void	LoadAllMatches ( FLoadTurnBasedMatchesSignature Matc... )	Load all matches the current player is participating in.
void	LoadMatchWithID ( FString MatchID, FLoadTurnBasedMatchWithIDSignature ... )	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, FRemoveMatchSignature RemoveMatchCa... )	Deletes a match entirely from the platform specific service.
void	SetEventDelegate ( FTurnBasedEventDelegateWeakPtr Dele... )	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 Del... )	Set a delegate to be called when matchmaking succeeds, fails, or is canceled.
void	ShowMatchmaker ( const FTurnBasedMatchRequest& Matc... )	Show the platform specific matchmaker interface with the parameters given in FTurnBasedMatchRequest.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss