Skip to main content
Version: 4.24

Online Session Subsystem

This API reference documents what methods and events are supported by Online Subsystem Blueprints. For full documentation on this API, refer to the Unreal Engine documentation.

Need to use a method or event that's not currently supported? Please reach out to support.

Supported Events#

EventSupported?Unreal Engine DocsParameters
OnCreateSessionComplete‚úĒDetailsFName¬†SessionName
bool bWasSuccessful
OnStartSessionComplete‚úĒDetailsFName¬†SessionName
bool bWasSuccessful
OnUpdateSessionComplete‚úĒDetailsFName¬†SessionName
bool bWasSuccessful
OnEndSessionComplete‚úĒDetailsFName¬†SessionName
bool bWasSuccessful
OnDestroySessionComplete‚úĒDetailsFName¬†SessionName
bool bWasSuccessful
OnMatchmakingComplete‚úĒDetailsFName¬†SessionName
bool bWasSuccessful
OnCancelMatchmakingComplete‚úĒDetailsFName¬†SessionName
bool bWasSuccessful
OnFindSessionsComplete‚úĒDetailsbool¬†bWasSuccessful
OnCancelFindSessionsComplete‚úĒDetailsbool¬†bWasSuccessful
OnPingSearchResultsComplete‚úĒDetailsbool¬†bWasSuccessful
OnJoinSessionComplete‚úĒDetailsFName¬†SessionName
EOnJoinSessionCompleteResult::Type Result
OnFindFriendSessionComplete‚úĒDetailsbool¬†bWasSuccessful
const TArray<FOnlineSessionSearchResult>& FriendSearchResult
OnSessionUserInviteAccepted‚úĒDetailsconst bool¬†bWasSuccessful
const int32 ControllerId
TSharedPtr<const FUniqueNetId> UserId
const FOnlineSessionSearchResult& InviteResult
OnSessionInviteReceived‚úĒDetailsconst FUniqueNetId&¬†UserId
const FUniqueNetId& FromId
const FString& AppId
const FOnlineSessionSearchResult& InviteResult
OnRegisterPlayersComplete‚úĒDetailsFName¬†SessionName
const TArray<TSharedRef<const FUniqueNetId>>& PlayerIds
bool bWasSuccessful
OnUnregisterPlayersComplete‚úĒDetailsFName¬†SessionName
const TArray<TSharedRef<const FUniqueNetId>>& PlayerIds
bool bWasSuccessful
OnSessionFailure‚úĒDetailsconst FUniqueNetId&¬†PlayerId
ESessionFailure::Type FailureType

Supported Functions#

FunctionSupported?Unreal Engine DocsParameters
CreateSessionIdFromString‚úĒDetailsconst FString&¬†SessionIdStr
GetNamedSession‚úĒDetailsFName¬†SessionName
RemoveNamedSession‚úĒDetailsFName¬†SessionName
HasPresenceSession‚úĒDetails
GetSessionState‚úĒDetailsFName¬†SessionName
CreateSession„ÄįDetailsint32¬†HostingPlayerNum
FName SessionName
const FOnlineSessionSettings& NewSessionSettings
CreateSession‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†HostingPlayerId
FName SessionName
const FOnlineSessionSettings& NewSessionSettings
StartSession‚úĒ¬†ūüēĒDetailsFName¬†SessionName
UpdateSession‚úĒ¬†ūüēĒDetailsFName¬†SessionName
FOnlineSessionSettings& UpdatedSessionSettings
bool bShouldRefreshOnlineData
EndSession‚úĒ¬†ūüēĒDetailsFName¬†SessionName
DestroySession‚úĒ¬†ūüēĒDetailsFName¬†SessionName
IsPlayerInSession‚úĒDetailsFName¬†SessionName
const FUniqueNetId& UniqueId
StartMatchmaking‚úĒ¬†ūüēĒDetailsconst TArray<TSharedRef<const FUniqueNetId>>&¬†LocalPlayers
FName SessionName
const FOnlineSessionSettings& NewSessionSettings
TSharedRef<FOnlineSessionSearch>& SearchSettings
CancelMatchmaking„ÄįDetailsint32¬†SearchingPlayerNum
FName SessionName
CancelMatchmaking‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†SearchingPlayerId
FName SessionName
FindSessions„ÄįDetailsint32¬†SearchingPlayerNum
const TSharedRef<FOnlineSessionSearch>& SearchSettings
FindSessions‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†SearchingPlayerId
const TSharedRef<FOnlineSessionSearch>& SearchSettings
FindSessionById„ÄįDetailsconst FUniqueNetId&¬†SearchingUserId
const FUniqueNetId& SessionId
const FUniqueNetId& FriendId
FindSessionById‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†SearchingUserId
const FUniqueNetId& SessionId
const FUniqueNetId& FriendId
const FString& UserData
CancelFindSessions‚úĒ¬†ūüēĒDetails
PingSearchResults‚úĒ¬†ūüēĒDetailsconst FOnlineSessionSearchResult&¬†SearchResult
JoinSession„ÄįDetailsint32¬†LocalUserNum
FName SessionName
const FOnlineSessionSearchResult& DesiredSession
JoinSession‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
FName SessionName
const FOnlineSessionSearchResult& DesiredSession
FindFriendSession‚úĒ¬†ūüēĒDetailsint32¬†LocalUserNum
const FUniqueNetId& Friend
FindFriendSession„ÄįDetailsconst FUniqueNetId&¬†LocalUserId
const FUniqueNetId& Friend
FindFriendSession„ÄįDetailsconst FUniqueNetId&¬†LocalUserId
const TArray<TSharedRef<const FUniqueNetId>>& FriendList
SendSessionInviteToFriend„ÄįDetailsint32¬†LocalUserNum
FName SessionName
const FUniqueNetId& Friend
SendSessionInviteToFriend‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
FName SessionName
const FUniqueNetId& Friend
SendSessionInviteToFriends„ÄįDetailsint32¬†LocalUserNum
FName SessionName
const TArray<TSharedRef<const FUniqueNetId>>& Friends
SendSessionInviteToFriends‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
FName SessionName
const TArray<TSharedRef<const FUniqueNetId>>& Friends
GetSessionSettings‚úĒDetailsFName¬†SessionName
RegisterPlayers‚úĒ¬†ūüēĒDetailsFName¬†SessionName
const TArray<TSharedRef<const FUniqueNetId>>& Players
bool bWasInvited
UnregisterPlayers‚úĒ¬†ūüēĒDetailsFName¬†SessionName
const TArray<TSharedRef<const FUniqueNetId>>& Players
RegisterLocalPlayer‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†PlayerId
FName SessionName
UnregisterLocalPlayer‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†PlayerId
FName SessionName
GetNumSessions‚úĒDetails
DumpSessionState‚úĒDetails