1. Epic GamesDeveloper
  3. UOnlineSessionClient

UOnlineSessionClient

API > API/Plugins > API/Plugins/OnlineSubsystemUtils

   
Name UOnlineSessionClient
Type class
Header File /Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Classes/OnlineSessionClient.h
Include Path #include "OnlineSessionClient.h"

Syntax

UCLASS (MinimalAPI, Config=Game)  
class UOnlineSessionClient : public UOnlineSession

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UOnlineSessionClient ( const FObjectInitializer& ObjectInitializer
)

   OnlineSessionClient.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void SetInviteFlags ( UWorld* World,
const FJoinabilitySettings& Settings
)

 Update the session settings on the client OnlineSessionClient.h  

Overridden from UOnlineSession

Name Remarks Include Path Unreal Specifiers

virtual void ClearOnlineDelegates()

   OnlineSessionClient.h  

virtual void EndOnlineSession ( FName SessionName
)

   OnlineSessionClient.h  

virtual void HandleDisconnect ( UWorld* World,
UNetDriver* NetDriver
)

   OnlineSessionClient.h  

virtual void RegisterOnlineDelegates()

   OnlineSessionClient.h  

virtual void StartOnlineSession ( FName SessionName
)

   OnlineSessionClient.h  

Protected

Name Remarks Include Path Unreal Specifiers

void DestroyExistingSession ( FName SessionName,
FOnDestroySessionCompleteDelegate& Delegate
)

 Destroys an existing session of a given name OnlineSessionClient.h  

void DestroyExistingSession_Impl ( FDelegateHandle& OutResult,
FName SessionName,
FOnDestroySessionCompleteDelegate& Delegate
)

 Implementation of DestroyExistingSession OnlineSessionClient.h  

void EndExistingSession ( FName SessionName,
FOnEndSessionCompleteDelegate& Delegate
)

 Ends an existing session of a given name OnlineSessionClient.h  

virtual UGameInstance * GetGameInstance()

   OnlineSessionClient.h  

virtual IOnlineSessionPtr GetSessionInt()

   OnlineSessionClient.h  

virtual UWorld * GetWorld()

   OnlineSessionClient.h  

virtual bool HandleDisconnectInternal ( UWorld* World,
UNetDriver* NetDriver
)

 Chance for the session client to handle the disconnect OnlineSessionClient.h  

virtual void JoinSession ( FName SessionName,
const FOnlineSessionSearchResult& SearchResult
)

 Join a session of a given name after potentially tearing down an existing one OnlineSessionClient.h  

void OnDestroyForJoinSessionComplete ( FName SessionName,
bool bWasSuccessful
)

 Transition from destroying a session to joining a new one of the same name OnlineSessionClient.h  

void OnDestroyForMainMenuComplete ( FName SessionName,
bool bWasSuccessful
)

 Transition from destroying a session to returning to the main menu OnlineSessionClient.h  

void OnEndForJoinSessionComplete ( FName SessionName,
bool bWasSuccessful
)

 Transition from ending a session to destroying a session OnlineSessionClient.h  

virtual void OnEndSessionComplete ( FName InSessionName,
bool bWasSuccessful
)

 Delegate called when EndSession has completed OnlineSessionClient.h  

void OnJoinSessionComplete ( FName SessionName,
EOnJoinSessionCompleteResult::Type Result
)

 Delegate fired when the joining process for an online session has completed OnlineSessionClient.h  

virtual void OnStartSessionComplete ( FName InSessionName,
bool bWasSuccessful
)

 Delegate called when StartSession has completed OnlineSessionClient.h  

Overridden from UOnlineSession

Name Remarks Include Path Unreal Specifiers

virtual void OnSessionUserInviteAccepted ( const bool bWasSuccess,
const int32 ControllerId,
FUniqueNetIdPtr UserId,
const FOnlineSessionSearchResult& InviteResult
)

 Called from GameInstance when the user accepts an invite OnlineSessionClient.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page