Functions
static bool	CreateSession (UObject *WorldContextObject, int HostingPlayerNum, FName SessionName, const FPicoOnlineSessionSettings &NewSessionSettings, FPicoManagerOnCreateSessionCompleteDelegate OnCreateSessionCompleteDelegate)
	Creates a private session or a matchmaking session. More...

static bool	StartSession (UObject *WorldContextObject, FName SessionName, FPicoManagerOnStartSessionCompleteDelegate OnStartSessionCompleteDelegate)
	Changes the session state to `InProgress`. More...

static bool	UpdateSession (UObject *WorldContextObject, FName SessionName, const FPicoOnlineSessionSettings &UpdatedSessionSettings, FPicoManagerOnUpdateSessionCompleteDelegate OnUpdateSessionCompleteDelegate, bool bShouldRefreshOnlineData=true)
	Updates the datastore of a session. More...

static bool	EndSession (UObject *WorldContextObject, FName SessionName, FPicoManagerOnEndSessionCompleteDelegate OnEndSessionCompleteDelegate)
	Changes the session state to `Ended`. More...

static bool	DestroySession (UObject *WorldContextObject, FName SessionName, FPicoManagerOnDestroySessionCompleteDelegate OnDestroySessionCompleteDelegate)
	Destroys the current session. More...

static bool	IsPlayerInSession (UObject *WorldContextObject, FName SessionName, const FString &UniqueId)
	Checks whether a player is in a session. More...

static bool	StartMatchmaking (UObject *WorldContextObject, const TArray< FString > &LocalPlayers, FName SessionName, const FPicoOnlineSessionSettings &NewSessionSettings, const FPicoOnlineSessionSearch &NewSessionSearch, FPicoManagerOnMatchmakingCompleteDelegate OnMatchmakingCompleteDelegate)
	Starts matchmaking for a session. More...

static bool	CancelMatchmaking (UObject *WorldContextObject, int SearchingPlayerNum, FName SessionName, FPicoManagerOnCancelMatchmakingCompleteDelegate OnCancelMatchmakingCompleteDelegate)
	Cancels matchmaking for a session. More...

static bool	FindSessions (UObject *WorldContextObject, int32 SearchingPlayerNum, const FPicoOnlineSessionSearch &NewSessionSearch, FPicoManagerOnFindSessionCompleteDelegate OnFindSessionCompleteDelegate)
	Finds matchmaking sessions or moderated sessions. More...

static bool	FindSessionById (UObject *WorldContextObject, const FString &SearchingUserId, const FString &SessionId, FPicoManagerOnSingleSessionResultCompleteDelegate OnSingleSessionResultCompleteDelegate)
	Gets session data by session ID. More...

static bool	JoinSession (UObject *WorldContextObject, int PlayerNum, FName SessionName, const FPicoOnlineSessionSearchResult &SearchResult, FPicoManagerOnJoinSessionCompleteDelegate OnJoinSessionCompleteDelegate)
	Joins a session. More...

static void	DumpSessionState (UObject *WorldContextObject)
	Dumps a session. More...

static EOnlineSessionStatePicoType	GetSessionState (UObject *WorldContextObject, FName SessionName)
	Gets the state of a session. More...

static FPicoNamedOnlineSession	GetNamedSession (UObject *WorldContextObject, FName SessionName)
	Gets the data about a session. More...

static FPicoNamedOnlineSession	AddNamedSessionBySettings (UObject *WorldContextObject, FName SessionName, const FPicoOnlineSessionSettings &SessionSettings)
	Adds session by session settings. More...

static FPicoNamedOnlineSession	AddNamedSession (UObject *WorldContextObject, FName SessionName, const FPicoOnlineSession &Session)
	Adds a session. More...

static FPicoOnlineSessionSettings	GetSessionSettings (UObject *WorldContextObject, FName SessionName)
	Gets the settings of a session. More...

Detailed Description

This is the BP_Session group

Function Documentation

◆ AddNamedSession()

static FPicoNamedOnlineSession AddNamedSession	(	UObject *	WorldContextObject,
		FName	SessionName,
		const FPicoOnlineSession &	Session
	)

static

Adds a session.

Parameters

WorldContextObject	Used to get the information about the current world.
SessionName	The session name.
Session	The session will be added.

Returns: The session added.

◆ AddNamedSessionBySettings()

static FPicoNamedOnlineSession AddNamedSessionBySettings	(	UObject *	WorldContextObject,
		FName	SessionName,
		const FPicoOnlineSessionSettings &	SessionSettings
	)

static

Adds session by session settings.

Parameters

WorldContextObject	Used to get the information about the current world.
SessionName	The session name.
SessionSettings	The settings of the session.

Returns: The session added.

◆ CancelMatchmaking()

static bool CancelMatchmaking	(	UObject *	WorldContextObject,
		int	SearchingPlayerNum,
		FName	SessionName,
		FPicoManagerOnCancelMatchmakingCompleteDelegate	OnCancelMatchmakingCompleteDelegate
	)

static

Cancels matchmaking for a session.

Parameters

WorldContextObject	Used to get the information about the current world.
SearchingPlayerNum	(not used)
SessionName	The session name.
OnCancelMatchmakingCompleteDelegate	Executes this parameter after the matchmaking has been canceled.

Returns

Bool:

true: success
false: falure

◆ CreateSession()

static bool CreateSession	(	UObject *	WorldContextObject,
		int	HostingPlayerNum,
		FName	SessionName,
		const FPicoOnlineSessionSettings &	NewSessionSettings,
		FPicoManagerOnCreateSessionCompleteDelegate	OnCreateSessionCompleteDelegate
	)

static

Creates a private session or a matchmaking session.

Parameters

WorldContextObject	Used to get the information about the current world.
HostingPlayerNum	The index in the current userId array.
SessionName	The session name.
NewSessionSettings	The session settings.
OnCreateSessionCompleteDelegate	Executes this parameter after the session has been created.

Returns

Bool:

true: success
false: falure

◆ DestroySession()

static bool DestroySession	(	UObject *	WorldContextObject,
		FName	SessionName,
		FPicoManagerOnDestroySessionCompleteDelegate	OnDestroySessionCompleteDelegate
	)

static

Destroys the current session.

Parameters

WorldContextObject	Used to get the information about the current world.
SessionName	The session name.
OnDestroySessionCompleteDelegate	Executes this parameter after the session has been destroyed.

Returns

Bool:

true: success
false: falure

◆ DumpSessionState()

static void DumpSessionState ( UObject * WorldContextObject )

static

Dumps a session.

Parameters

WorldContextObject Used to get the information about the current world.

◆ EndSession()

static bool EndSession	(	UObject *	WorldContextObject,
		FName	SessionName,
		FPicoManagerOnEndSessionCompleteDelegate	OnEndSessionCompleteDelegate
	)

static

Changes the session state to Ended.

Parameters

WorldContextObject	Used to get the information about the current world.
SessionName	The session name.
OnEndSessionCompleteDelegate	Executes this parameter after the session has been ended.

Returns

Bool:

true: success
false: falure

◆ FindSessionById()

static bool FindSessionById	(	UObject *	WorldContextObject,
		const FString &	SearchingUserId,
		const FString &	SessionId,
		FPicoManagerOnSingleSessionResultCompleteDelegate	OnSingleSessionResultCompleteDelegate
	)

static

Gets session data by session ID.

Parameters

WorldContextObject	Used to get the information about the current world.
SearchingUserId	The ID of the logged-in player. If the played has not logged in, the session data will be unable to get.
SessionId	The session ID.
OnSingleSessionResultCompleteDelegate	Executes this parameter after the session data has been got.

Returns

Bool:

true: success
false: falure

◆ FindSessions()

static bool FindSessions	(	UObject *	WorldContextObject,
		int32	SearchingPlayerNum,
		const FPicoOnlineSessionSearch &	NewSessionSearch,
		FPicoManagerOnFindSessionCompleteDelegate	OnFindSessionCompleteDelegate
	)

static

Finds matchmaking sessions or moderated sessions.

Parameters

WorldContextObject	Used to get the information about the current world.
SearchingPlayerNum	(not used)
NewSessionSearch	The search settings.
OnFindSessionCompleteDelegate	Executes this parameter after the session has been found.

Returns

Bool:

true: success
false: falure

◆ GetNamedSession()

static FPicoNamedOnlineSession GetNamedSession	(	UObject *	WorldContextObject,
		FName	SessionName
	)

static

Gets the data about a session.

Parameters

WorldContextObject	Used to get the information about the current world.
SessionName	The session name.

Returns: The data about the session.

◆ GetSessionSettings()

static FPicoOnlineSessionSettings GetSessionSettings	(	UObject *	WorldContextObject,
		FName	SessionName
	)

static

Gets the settings of a session.

Parameters

WorldContextObject	Used to get the information about the current world.
SessionName	The session name.

Returns: The settings of the session.

◆ GetSessionState()

static EOnlineSessionStatePicoType GetSessionState	(	UObject *	WorldContextObject,
		FName	SessionName
	)

static

Gets the state of a session.

Parameters

WorldContextObject	Used to get the information about the current world.
SessionName	The name of the session to get state for.

Returns: The state of the session.

◆ IsPlayerInSession()

static bool IsPlayerInSession	(	UObject *	WorldContextObject,
		FName	SessionName,
		const FString &	UniqueId
	)

static

Checks whether a player is in a session.

Parameters

WorldContextObject	Used to get the information about the current world.
SessionName	The session name.
UniqueId	The unique ID of the player.

Returns

Bool:

true: success
false: falure

◆ JoinSession()

static bool JoinSession	(	UObject *	WorldContextObject,
		int	PlayerNum,
		FName	SessionName,
		const FPicoOnlineSessionSearchResult &	SearchResult,
		FPicoManagerOnJoinSessionCompleteDelegate	OnJoinSessionCompleteDelegate
	)

static

Joins a session.

Parameters

WorldContextObject	Used to get the information about the current world.
PlayerNum	The `LocalOwnerId` of the session.
SessionName	The name of the session to join.
SearchResult	The search session result settings.
OnJoinSessionCompleteDelegate	Executes this parameter after the session has been joined.

Returns

Bool:

true: success
false: falure

◆ StartMatchmaking()

static bool StartMatchmaking	(	UObject *	WorldContextObject,
		const TArray< FString > &	LocalPlayers,
		FName	SessionName,
		const FPicoOnlineSessionSettings &	NewSessionSettings,
		const FPicoOnlineSessionSearch &	NewSessionSearch,
		FPicoManagerOnMatchmakingCompleteDelegate	OnMatchmakingCompleteDelegate
	)

static

Starts matchmaking for a session.

Parameters

WorldContextObject	Used to get the information about the current world.
LocalPlayers	The logged-in users in the session.
SessionName	The session name.
NewSessionSettings	Set `NumPrivateConnections` to `0`.
NewSessionSearch	Used to modify the search state.
OnMatchmakingCompleteDelegate	Executes this parameter after the matchmaking has been completed.

Returns

Bool:

true: success
false: falure

◆ StartSession()

static bool StartSession	(	UObject *	WorldContextObject,
		FName	SessionName,
		FPicoManagerOnStartSessionCompleteDelegate	OnStartSessionCompleteDelegate
	)

static

Changes the session state to InProgress.

Parameters

WorldContextObject	Used to get the information about the current world.
SessionName	The session name.
OnStartSessionCompleteDelegate	Executes this parameter after the session has been started.

Returns

Bool:

true: success
false: falure

◆ UpdateSession()

static bool UpdateSession	(	UObject *	WorldContextObject,
		FName	SessionName,
		const FPicoOnlineSessionSettings &	UpdatedSessionSettings,
		FPicoManagerOnUpdateSessionCompleteDelegate	OnUpdateSessionCompleteDelegate,
		bool	bShouldRefreshOnlineData = `true`
	)

static

Updates the datastore of a session.

Parameters

WorldContextObject	Used to get the information about the current world.
SessionName	The session name.
UpdatedSessionSettings	The settings with new datastore.
bShouldRefreshOnlineData	(not used)
OnUpdateSessionCompleteDelegate	Executes this parameter after the session has been updated.

Returns

Bool:

true: success
false: falure

Functions

Detailed Description

Function Documentation

◆ AddNamedSession()

◆ AddNamedSessionBySettings()

◆ CancelMatchmaking()

◆ CreateSession()

◆ DestroySession()

◆ DumpSessionState()

◆ EndSession()

◆ FindSessionById()

◆ FindSessions()

◆ GetNamedSession()

◆ GetSessionSettings()

◆ GetSessionState()

◆ IsPlayerInSession()

◆ JoinSession()

◆ StartMatchmaking()

◆ StartSession()

◆ UpdateSession()