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

> Unreal Engine API Reference > Plugins > OnlineSubsystem > Interfaces > IOnlineTournament

Light Theme

Dark Theme

IOnlineTournament

Interface to handle requesting and submitting information related to tournaments

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

IOnlineTournament

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineTournamentInterface.h
Include	#include "Interfaces/OnlineTournamentInterface.h"

Syntax

class IOnlineTournament : public TSharedFromThis< IOnlineTournament, ESPMode::ThreadSafe >

Remarks

Interface to handle requesting and submitting information related to tournaments

Destructors

	Name	Description
	~IOnlineTournament()

Functions

	Name	Description
FDelegateHan...	AddOnOnlineTournamentMatchJoinedDelegate ( const FOnOnlineTournamentMatchJoine... )	Register for updates when a tournament match has been joined
FDelegateHan...	AddOnOnlineTournamentTournamentJoined ( const FOnOnlineTournamentTournament... )	Register for updates when a tournament has been joined
void	DumpCachedMatchInfo ( const FUniqueNetIdRef UserId )	Print all cached match information into the logs
void	DumpCachedParticipantInfo ( const FUniqueNetIdRef UserId )	Print all cached participant information into the logs
void	DumpCachedTeamInfo ( const FUniqueNetIdRef UserId )	Print all cached team information into the logs
void	DumpCachedTournamentInfo ( const FUniqueNetIdRef UserId )	Print all cached tournament information into the logs
TArray< TSha...	GetMatchDetails ( const FUniqueNetIdRef UserId, const TArray< FOnlineTournamentMatc... )	Get match details that have been previously queried by the specified user.
TSharedPtr< ...	GetMatchDetails ( const FUniqueNetIdRef UserId, const FOnlineTournamentMatchIdRef M... )	Get a match's details that have been previously queried by the specified user.
TArray< FOnl...	GetMatchList ( const FUniqueNetIdRef UserId, const FOnlineTournamentIdRef Tourna... )	Get match detail results for that have been previously queried by the specified user.
TArray< TSha...	GetParticipantList ( const FUniqueNetIdRef UserId, const FOnlineTournamentIdRef Tourna..., const EOnlineTournamentParticipantT... )	Get Participant details that have been previously queried by the specified user.
TArray< TSha...	GetTeamDetails ( const FUniqueNetIdRef UserId, const TArray< FOnlineTournamentTeam... )	Get team details that have been previously queried by the specified user.
TSharedPtr< ...	GetTeamDetails ( const FUniqueNetIdRef UserId, const FOnlineTournamentTeamIdRef Te... )	Get a teams's details that have been previously queried by the specified user.
TArray< TSha...	GetTournamentDetails ( const FUniqueNetIdRef UserId, const TArray< FOnlineTournamentIdRe... )	Get tournament detail results for specified tournaments that have been previously queried by the specified user.
TSharedPtr< ...	GetTournamentDetails ( const FUniqueNetIdRef UserId, const FOnlineTournamentIdRef Tourna... )	Get a tournament details result for a tournament that had been previously queried by the specified user.
TArray< FOnl...	GetTournamentList ( const FUniqueNetIdRef UserId )	Get a list of all Tournament IDs that have been queried by the specified user.
void	QueryMatchDetails ( const FUniqueNetIdRef UserId, const TArray< FOnlineTournamentMatc..., const FOnlineTournamentQueryMatchDe... )	Query match details for a tournament from the perspective of the specified user.
void	QueryMatchList ( const FUniqueNetIdRef UserId, const FOnlineTournamentIdRef Tourna..., const FOnlineTournamentQueryMatchLi... )	Query a list of matches for a tournament from the perspective of the specified user.
void	QueryParticipantList ( const FUniqueNetIdRef UserId, const FOnlineTournamentIdRef Tourna..., const FOnlineTournamentParticipantQ..., const FOnlineTournamentQueryPartici... )	Query a list of participants for a tournament from the perspective of the specified user.
void	QueryTeamDetails ( const FUniqueNetIdRef UserId, const TArray< FOnlineTournamentTeam..., const FOnlineTournamentQueryTeamDet... )	Query team details from the perspective of the specified user.
void	QueryTournamentDetails ( const FUniqueNetIdRef UserId, const TArray< FOnlineTournamentIdRe..., const FOnlineTournamentQueryTournam... )	Query tournament details from the perspective of the specified user.
void	QueryTournamentList ( const FUniqueNetIdRef UserId, const FOnlineTournamentQueryFilter ..., const FOnlineTournamentQueryTournam... )	Query a list of tournaments available for a user using specified filters.
void	RemoveOnOnlineTournamentMatchJoinedDelegate ( const FDelegateHandle& DelegateHan... )	Unregister for tournament match join updates using a previously-registered delegate handle
void	RemoveOnOnlineTournamentTournamentJoined ( const FDelegateHandle& DelegateHan... )	Unregister for tournament join updates using a previously-registered delegate handle
void	SubmitMatchResults ( const FUniqueNetIdRef UserId, const FOnlineTournamentMatchIdRef M..., const FOnlineTournamentMatchResults..., const FOnlineTournamentSubmitMatchR... )	Submit match results for a tournament match.

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

Take our survey

Dismiss