1. Epic GamesDeveloper
  3. IOnlineTournament

IOnlineTournament

Interface to handle requesting and submitting information related to tournaments

API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces

Inheritance Hierarchy

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

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function FDelegateHandle Register for updates when a tournament match has been joined
Public function FDelegateHandle Register for updates when a tournament has been joined
Public function Const void

DumpCachedMatchInfo ( const FUniqueNetIdRef UserId
)

 Print all cached match information into the logs
Public function Const void

DumpCachedParticipantInfo ( const FUniqueNetIdRef UserId
)

 Print all cached participant information into the logs
Public function Const void

DumpCachedTeamInfo ( const FUniqueNetIdRef UserId
)

 Print all cached team information into the logs
Public function Const void

DumpCachedTournamentInfo ( const FUniqueNetIdRef UserId
)

 Print all cached tournament information into the logs
Public function Const TArray< TSharedPtr< const IOnlineTournamentMatchDetails > >

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

 Get match details that have been previously queried by the specified user.
Public function Const TSharedPtr< const IOnlineTournamentMatchDetails >

GetMatchDetails ( const FUniqueNetIdRef UserId,
const FOnlineTournamentMatchIdRef MatchId
)

 Get a match's details that have been previously queried by the specified user.
Public function Const TArray< FOnlineTournamentMatchIdRef >

GetMatchList ( const FUniqueNetIdRef UserId,
const FOnlineTournamentIdRef TournamentId
)

 Get match detail results for that have been previously queried by the specified user.
Public function Const TArray< TSharedRef< const IOnlineTournamentParticipantDetails > >

GetParticipantList ( const FUniqueNetIdRef UserId,
const FOnlineTournamentIdRef TournamentId,
const EOnlineTournamentParticipantType ParticipantType
)

 Get Participant details that have been previously queried by the specified user.
Public function Const TArray< TSharedPtr< const IOnlineTournamentTeamDetails > >

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

 Get team details that have been previously queried by the specified user.
Public function Const TSharedPtr< const IOnlineTournamentTeamDetails >

GetTeamDetails ( const FUniqueNetIdRef UserId,
const FOnlineTournamentTeamIdRef TeamId
)

 Get a teams's details that have been previously queried by the specified user.
Public function Const TArray< TSharedPtr< const IOnlineTournamentDetails > >

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

 Get tournament detail results for specified tournaments that have been previously queried by the specified user.
Public function Const TSharedPtr< const IOnlineTournamentDetails >

GetTournamentDetails ( const FUniqueNetIdRef UserId,
const FOnlineTournamentIdRef TournamentId
)

 Get a tournament details result for a tournament that had been previously queried by the specified user.
Public function Const TArray< FOnlineTournamentIdRef >

GetTournamentList ( const FUniqueNetIdRef UserId
)

 Get a list of all Tournament IDs that have been queried by the specified user.
Public function 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.
Public function 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.
Public function 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.
Public function void

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

 Query team details from the perspective of the specified user.
Public function void

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

 Query tournament details from the perspective of the specified user.
Public function void

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

 Query a list of tournaments available for a user using specified filters.
Public function void Unregister for tournament match join updates using a previously-registered delegate handle
Public function void Unregister for tournament join updates using a previously-registered delegate handle
Public function void

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

 Submit match results for a tournament match.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page