FOnlineSessionV1AccelByte Class Reference

Inheritance diagram for FOnlineSessionV1AccelByte:

Public Member Functions
	DEFINE_ONLINE_DELEGATE_ONE_PARAM (OnReadyConsentRequested, FString)
	DEFINE_ONLINE_DELEGATE (OnMatchmakingStarted)
virtual FUniqueNetIdPtr	CreateSessionIdFromString (const FString &SessionIdStr) override
virtual FNamedOnlineSession *	GetNamedSession (FName SessionName) override
virtual void	RemoveNamedSession (FName SessionName) override
virtual EOnlineSessionState::Type	GetSessionState (FName SessionName) const override
virtual bool	HasPresenceSession () override
virtual bool	CreateSession (int32 HostingPlayerNum, FName SessionName, const FOnlineSessionSettings &NewSessionSettings) override
virtual bool	CreateSession (const FUniqueNetId &HostingPlayerId, FName SessionName, const FOnlineSessionSettings &NewSessionSettings) override
virtual bool	StartSession (FName SessionName) override
virtual bool	UpdateSession (FName SessionName, FOnlineSessionSettings &UpdatedSessionSettings, bool bShouldRefreshOnlineData=true) override
virtual bool	EndSession (FName SessionName) override
virtual bool	DestroySession (FName SessionName, const FOnDestroySessionCompleteDelegate &CompletionDelegate=FOnDestroySessionCompleteDelegate()) override
virtual bool	IsPlayerInSession (FName SessionName, const FUniqueNetId &UniqueId) override
virtual bool	StartMatchmaking (const TArray< TSharedRef< const FUniqueNetId > > &LocalPlayers, FName SessionName, const FOnlineSessionSettings &NewSessionSettings, TSharedRef< FOnlineSessionSearch > &SearchSettings) override
virtual bool	CancelMatchmaking (int32 SearchingPlayerNum, FName SessionName) override
virtual bool	CancelMatchmaking (const FUniqueNetId &SearchingPlayerId, FName SessionName) override
virtual bool	FindSessions (int32 SearchingPlayerNum, const TSharedRef< FOnlineSessionSearch > &SearchSettings) override
virtual bool	FindSessions (const FUniqueNetId &SearchingPlayerId, const TSharedRef< FOnlineSessionSearch > &SearchSettings) override
virtual bool	FindSessionById (const FUniqueNetId &SearchingUserId, const FUniqueNetId &SessionId, const FUniqueNetId &FriendId, const FOnSingleSessionResultCompleteDelegate &CompletionDelegate) override
virtual bool	CancelFindSessions () override
virtual bool	PingSearchResults (const FOnlineSessionSearchResult &SearchResult) override
virtual bool	JoinSession (int32 PlayerNum, FName SessionName, const FOnlineSessionSearchResult &DesiredSession) override
virtual bool	JoinSession (const FUniqueNetId &PlayerId, FName SessionName, const FOnlineSessionSearchResult &DesiredSession) override
virtual bool	FindFriendSession (int32 LocalUserNum, const FUniqueNetId &Friend) override
virtual bool	FindFriendSession (const FUniqueNetId &LocalUserId, const FUniqueNetId &Friend) override
virtual bool	FindFriendSession (const FUniqueNetId &LocalUserId, const TArray< TSharedRef< const FUniqueNetId > > &FriendList) override
virtual bool	SendSessionInviteToFriend (int32 LocalUserNum, FName SessionName, const FUniqueNetId &Friend) override
virtual bool	SendSessionInviteToFriend (const FUniqueNetId &LocalUserId, FName SessionName, const FUniqueNetId &Friend) override
virtual bool	SendSessionInviteToFriends (int32 LocalUserNum, FName SessionName, const TArray< TSharedRef< const FUniqueNetId > > &Friends) override
virtual bool	SendSessionInviteToFriends (const FUniqueNetId &LocalUserId, FName SessionName, const TArray< TSharedRef< const FUniqueNetId > > &Friends) override
virtual bool	GetResolvedConnectString (FName SessionName, FString &ConnectInfo, FName PortType) override
virtual bool	GetResolvedConnectString (const FOnlineSessionSearchResult &SearchResult, FName PortType, FString &ConnectInfo) override
virtual FOnlineSessionSettings *	GetSessionSettings (FName SessionName) override
virtual bool	RegisterPlayer (FName SessionName, const FUniqueNetId &PlayerId, bool bWasInvited) override
virtual bool	RegisterPlayers (FName SessionName, const TArray< TSharedRef< const FUniqueNetId > > &Players, bool bWasInvited=false) override
virtual bool	UnregisterPlayer (FName SessionName, const FUniqueNetId &PlayerId) override
virtual bool	UnregisterPlayers (FName SessionName, const TArray< TSharedRef< const FUniqueNetId > > &Players) override
virtual void	RegisterLocalPlayer (const FUniqueNetId &PlayerId, FName SessionName, const FOnRegisterLocalPlayerCompleteDelegate &Delegate) override
virtual void	UnregisterLocalPlayer (const FUniqueNetId &PlayerId, FName SessionName, const FOnUnregisterLocalPlayerCompleteDelegate &Delegate) override
virtual int32	GetNumSessions () override
virtual void	DumpSessionState () override
void	CancelMatchmakingNotification ()
	DEFINE_ONLINE_DELEGATE_ONE_PARAM (OnMatchmakingFailed, const FErrorInfo &)
void	DeregisterSession (FName SessionName, const FOnDeregisterSessionComplete &Delegate)
void	SendReady (int32 LocalUserNum, const FString &MatchId, const FOnSendReadyConsentComplete &Delegate=FOnSendReadyConsentComplete())
void	SetDefaultSessionSettings (const FOnlineSessionSettings &DefaultSettings)
TSharedPtr< FOnlineSessionSearch >	GetSessionSearch ()
void	EnqueueJoinableSession (FName SessionName, const FOnEnqueueJoinableSessionComplete &Delegate=FOnEnqueueJoinableSessionComplete())
void	DequeueJoinableSession (FName SessionName, const FOnDequeueJoinableSessionComplete &Delegate=FOnDequeueJoinableSessionComplete())
bool	QueryDedicatedSessionInfo (FName SessionName, const FOnQueryDedicatedSessionInfoComplete &Delegate=FOnQueryDedicatedSessionInfoComplete())
bool	RemoveUserFromSession (const FUniqueNetId &LocalUserId, const FString &ChannelName, const FString &MatchId, const FOnRemoveUserFromSessionComplete &Delegate=FOnRemoveUserFromSessionComplete())
void	SendMatchStartEvent (FName SessionName, const FString &Playlist, const FOnSendStartMatchEventComplete &Delegate=FOnSendStartMatchEventComplete())
FString	GetMatchmakingTicketId ()
void	SetMatchmakingTicketId (const FString &TicketId)
void	ClearMatchmakingTicketId ()
void	ContinueCreatePendingMatchFromDSNotif (const FString &MatchId)
virtual void	SendBanUser (FName SessionName, const FUniqueNetId &PlayerId, int32 InActionID, const FString &InMessage)
void	TriggerOnDedicatedServerNotificationReceived (const FAccelByteModelsDsNotice &Notification)
bool	ConstructGameSessionFromBackendSessionModel (const FAccelByteModelsSessionBrowserData &BackendSession, FOnlineSession &OutResult)

Static Public Member Functions
static bool	GetFromSubsystem (const IOnlineSubsystem *Subsystem, TSharedPtr< FOnlineSessionV1AccelByte, ESPMode::ThreadSafe > &OutInterfaceInstance)
static bool	GetFromWorld (const UWorld *World, TSharedPtr< FOnlineSessionV1AccelByte, ESPMode::ThreadSafe > &OutInterfaceInstance)

Member Function Documentation

CancelMatchmakingNotification()

void FOnlineSessionV1AccelByte::CancelMatchmakingNotification

(

)

Used to handle notification regarding matchmaking being canceled by the party leader. Can also be used by non-party leaders to back out of matchmaking.

ClearMatchmakingTicketId()

void FOnlineSessionV1AccelByte::ClearMatchmakingTicketId

(

)

Empty matchmaking ticket id locally

ConstructGameSessionFromBackendSessionModel()

bool FOnlineSessionV1AccelByte::ConstructGameSessionFromBackendSessionModel	(	const FAccelByteModelsSessionBrowserData &	BackendSession,
		FOnlineSession &	OutResult )

Construct a new session search result instance from a backend representation of a game session

ContinueCreatePendingMatchFromDSNotif()

void FOnlineSessionV1AccelByte::ContinueCreatePendingMatchFromDSNotif

(

const FString &

MatchId

)

Continue create pending match data

DEFINE_ONLINE_DELEGATE()

FOnlineSessionV1AccelByte::DEFINE_ONLINE_DELEGATE

(

OnMatchmakingStarted

)

Delegate fired when matchmaking has started.

DEFINE_ONLINE_DELEGATE_ONE_PARAM()

FOnlineSessionV1AccelByte::DEFINE_ONLINE_DELEGATE_ONE_PARAM	(	OnReadyConsentRequested	,
		FString	)

Delegate fired when we need to send a ready consent message to the matchmaker to join a match.

Normally, you'll either want to just call SessionInt->SendReady(MatchId) if you don't care if players ready up, or have UI to send an explicit ready.

DequeueJoinableSession()

void FOnlineSessionV1AccelByte::DequeueJoinableSession	(	FName	SessionName,
		const FOnDequeueJoinableSessionComplete &	Delegate = FOnDequeueJoinableSessionComplete() )

Dequeues a joinable session on the backend, disabling backfill through matchmaker.

DeregisterSession()

void FOnlineSessionV1AccelByte::DeregisterSession	(	FName	SessionName,
		const FOnDeregisterSessionComplete &	Delegate )

Method to deregister a local or remote server from Armada by its session.

EnqueueJoinableSession()

void FOnlineSessionV1AccelByte::EnqueueJoinableSession	(	FName	SessionName,
		const FOnEnqueueJoinableSessionComplete &	Delegate = FOnEnqueueJoinableSessionComplete() )

Enqueues a session to be joinable on the backend, allows for backfill with matchmaking.

GetFromSubsystem()

bool FOnlineSessionV1AccelByte::GetFromSubsystem ( const IOnlineSubsystem * Subsystem, TSharedPtr< FOnlineSessionV1AccelByte, ESPMode::ThreadSafe > & OutInterfaceInstance )

static

Convenience method to get an instance of this interface from the subsystem passed in.

Parameters

Subsystem	Subsystem instance that we wish to get this interface from
OutInterfaceInstance	Instance of the interface that we got from the subsystem, or nullptr if not found

Returns

boolean that is true if we could get an instance of the interface, false otherwise

GetFromWorld()

bool FOnlineSessionV1AccelByte::GetFromWorld ( const UWorld * World, TSharedPtr< FOnlineSessionV1AccelByte, ESPMode::ThreadSafe > & OutInterfaceInstance )

static

Convenience method to get an instance of this interface from the subsystem associated with the world passed in.

Parameters

World	World instance that we wish to get the interface from
OutInterfaceInstance	Instance of the interface that we got from the subsystem, or nullptr if not found

Returns

boolean that is true if we could get an instance of the interface, false otherwise

GetMatchmakingTicketId()

FString FOnlineSessionV1AccelByte::GetMatchmakingTicketId

(

)

Get matchmaking ticket id

GetSessionSearch()

TSharedPtr< FOnlineSessionSearch > FOnlineSessionV1AccelByte::GetSessionSearch

(

)

Grabs the current search handle for matchmaking, should be used to get matchmaking status if we did not explicitly start matchmaking.

QueryDedicatedSessionInfo()

bool FOnlineSessionV1AccelByte::QueryDedicatedSessionInfo	(	FName	SessionName,
		const FOnQueryDedicatedSessionInfoComplete &	Delegate = FOnQueryDedicatedSessionInfoComplete() )

Query information about a dedicated session from the backend, used to get team and party associations from backfill

RemoveUserFromSession()

bool FOnlineSessionV1AccelByte::RemoveUserFromSession	(	const FUniqueNetId &	LocalUserId,
		const FString &	ChannelName,
		const FString &	MatchId,
		const FOnRemoveUserFromSessionComplete &	Delegate = FOnRemoveUserFromSessionComplete() )

Remove a user from session in the channel

SendMatchStartEvent()

void FOnlineSessionV1AccelByte::SendMatchStartEvent	(	FName	SessionName,
		const FString &	Playlist,
		const FOnSendStartMatchEventComplete &	Delegate = FOnSendStartMatchEventComplete() )

#SG Send event to session browser service that we have started a match for this session

SendReady()

void FOnlineSessionV1AccelByte::SendReady	(	int32	LocalUserNum,
		const FString &	MatchId,
		const FOnSendReadyConsentComplete &	Delegate = FOnSendReadyConsentComplete() )

Sends off a ready consent request for the specified match ID.

SetDefaultSessionSettings()

void FOnlineSessionV1AccelByte::SetDefaultSessionSettings

(

const FOnlineSessionSettings &

DefaultSettings

)

Sets the default settings for a session to be created with. Used for matchmaking sessions when we did not explicitly start matchmaking ourselves (ex. if a party leader starts matchmaking).

SetMatchmakingTicketId()

void FOnlineSessionV1AccelByte::SetMatchmakingTicketId

(

const FString &

TicketId

)

Set matchmaking ticket ids locally