1. Epic GamesDeveloper
  3. IOnlineTournament

IOnlineTournament

Interface to handle requesting and submitting information related to tournaments

API > API/Plugins > API/Plugins/OnlineSubsystem

Interface to handle requesting and submitting information related to tournaments

   
Name IOnlineTournament
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineTournamentInterface.h
Include Path #include "Interfaces/OnlineTournamentInterface.h"

Syntax

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

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IOnlineTournament()

   Interfaces/OnlineTournamentInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FDelegateHandle AddOnOnlineTournamentMatchJoinedDelegate ( const FOnOnlineTournamentMatchJoinedDelegate& Delegate
)

 Register for updates when a tournament match has been joined Interfaces/OnlineTournamentInterface.h  

FDelegateHandle AddOnOnlineTournamentTournamentJoined ( const FOnOnlineTournamentTournamentJoinedDelegate& Delegate
)

 Register for updates when a tournament has been joined Interfaces/OnlineTournamentInterface.h  

void DumpCachedMatchInfo ( const FUniqueNetIdRef UserId
) const

 Print all cached match information into the logs Interfaces/OnlineTournamentInterface.h  

void DumpCachedParticipantInfo ( const FUniqueNetIdRef UserId
) const

 Print all cached participant information into the logs Interfaces/OnlineTournamentInterface.h  

void DumpCachedTeamInfo ( const FUniqueNetIdRef UserId
) const

 Print all cached team information into the logs Interfaces/OnlineTournamentInterface.h  

void DumpCachedTournamentInfo ( const FUniqueNetIdRef UserId
) const

 Print all cached tournament information into the logs Interfaces/OnlineTournamentInterface.h  

TArray< TSharedPtr< const IOnlineTournamentMatchDetails > > GetMatchDetails ( const FUniqueNetIdRef UserId,
const TArray< FOnlineTournamentMatchIdRef >& MatchIds
) const

 Get match details that have been previously queried by the specified user. Interfaces/OnlineTournamentInterface.h  

TSharedPtr< const IOnlineTournamentMatchDetails > GetMatchDetails ( const FUniqueNetIdRef UserId,
const FOnlineTournamentMatchIdRef MatchId
) const

 Get a match's details that have been previously queried by the specified user. Interfaces/OnlineTournamentInterface.h  

TArray< FOnlineTournamentMatchIdRef > GetMatchList ( const FUniqueNetIdRef UserId,
const FOnlineTournamentIdRef TournamentId
) const

 Get match detail results for that have been previously queried by the specified user. Interfaces/OnlineTournamentInterface.h  

TArray< TSharedRef< const IOnlineTournamentParticipantDetails > > GetParticipantList ( const FUniqueNetIdRef UserId,
const FOnlineTournamentIdRef TournamentId,
const EOnlineTournamentParticipantType ParticipantType
) const

 Get Participant details that have been previously queried by the specified user. Interfaces/OnlineTournamentInterface.h  

TArray< TSharedPtr< const IOnlineTournamentTeamDetails > > GetTeamDetails ( const FUniqueNetIdRef UserId,
const TArray< FOnlineTournamentTeamIdRef >& TeamIds
) const

 Get team details that have been previously queried by the specified user. Interfaces/OnlineTournamentInterface.h  

TSharedPtr< const IOnlineTournamentTeamDetails > GetTeamDetails ( const FUniqueNetIdRef UserId,
const FOnlineTournamentTeamIdRef TeamId
) const

 Get a teams's details that have been previously queried by the specified user. Interfaces/OnlineTournamentInterface.h  

TArray< TSharedPtr< const IOnlineTournamentDetails > > GetTournamentDetails ( const FUniqueNetIdRef UserId,
const TArray< FOnlineTournamentIdRef >& TournamentIds
) const

 Get tournament detail results for specified tournaments that have been previously queried by the specified user. Interfaces/OnlineTournamentInterface.h  

TSharedPtr< const IOnlineTournamentDetails > GetTournamentDetails ( const FUniqueNetIdRef UserId,
const FOnlineTournamentIdRef TournamentId
) const

 Get a tournament details result for a tournament that had been previously queried by the specified user. Interfaces/OnlineTournamentInterface.h  

TArray< FOnlineTournamentIdRef > GetTournamentList ( const FUniqueNetIdRef UserId
) const

 Get a list of all Tournament IDs that have been queried by the specified user. Interfaces/OnlineTournamentInterface.h  

void QueryMatchDetails ( const FUniqueNetIdRef UserId,
const TArray< FOnlineTournamentMatchIdRef >& MatchIds,
const FOnlineTournamentQueryMatchDetailsComplete& Delegate
)

 Query match details for a tournament from the perspective of the specified user. Interfaces/OnlineTournamentInterface.h  

void QueryMatchList ( const FUniqueNetIdRef UserId,
const FOnlineTournamentIdRef TournamentId,
const FOnlineTournamentQueryMatchListComplete& Delegate
)

 Query a list of matches for a tournament from the perspective of the specified user. Interfaces/OnlineTournamentInterface.h  

void QueryParticipantList ( const FUniqueNetIdRef UserId,
const FOnlineTournamentIdRef TournamentId,
const FOnlineTournamentParticipantQueryFilter& QueryFilter,
const FOnlineTournamentQueryParticipantListComplete& Delegate
)

 Query a list of participants for a tournament from the perspective of the specified user. Interfaces/OnlineTournamentInterface.h  

void QueryTeamDetails ( const FUniqueNetIdRef UserId,
const TArray< FOnlineTournamentTeamIdRef >& TeamIds,
const FOnlineTournamentQueryTeamDetailsComplete& Delegate
)

 Query team details from the perspective of the specified user. Interfaces/OnlineTournamentInterface.h  

void QueryTournamentDetails ( const FUniqueNetIdRef UserId,
const TArray< FOnlineTournamentIdRef >& TournamentIds,
const FOnlineTournamentQueryTournamentDetailsComplete& Delegate
)

 Query tournament details from the perspective of the specified user. Interfaces/OnlineTournamentInterface.h  

void QueryTournamentList ( const FUniqueNetIdRef UserId,
const FOnlineTournamentQueryFilter& QueryFilter,
const FOnlineTournamentQueryTournamentListComplete& Delegate
)

 Query a list of tournaments available for a user using specified filters. Interfaces/OnlineTournamentInterface.h  

void RemoveOnOnlineTournamentMatchJoinedDelegate ( const FDelegateHandle& DelegateHandle
)

 Unregister for tournament match join updates using a previously-registered delegate handle Interfaces/OnlineTournamentInterface.h  

void RemoveOnOnlineTournamentTournamentJoined ( const FDelegateHandle& DelegateHandle
)

 Unregister for tournament join updates using a previously-registered delegate handle Interfaces/OnlineTournamentInterface.h  

void SubmitMatchResults ( const FUniqueNetIdRef UserId,
const FOnlineTournamentMatchIdRef MatchId,
const FOnlineTournamentMatchResults& MatchResults,
const FOnlineTournamentSubmitMatchResultsComplete& Delegate
)

 Submit match results for a tournament match. Interfaces/OnlineTournamentInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page