Protected Member Functions
proto native EBiosError	EnterGameplaySessionAsync (string session_address, int session_port)
	Enter a gameplay session.

proto native EBiosError	LeaveGameplaySessionAsync (string session_address, int session_port)
	Leave a gameplay session.

proto native void	OnSessionPlayerListUpdate (array< string > newPlayers)
	Alerts engine that players in current session have changed.

void	TryGetSession (string join_handle="")
	Gets a session from a join handle.

proto native EBiosError	GetSessionAsync (string join_handle)
	Gets a session from a join handle.

proto native EBiosError	SetGameplayActivityAsync (string session_address, int session_port)
	Sets the activity to a gameplay session.

proto native EBiosError	ClearActivityAsync ()
	not implemented

proto native EBiosError	ShowInviteToGameplaySessionAsync (string session_address, int session_port)
	Show system UI to invite friends to current gameplay session.

proto native EBiosError	InviteToGameplaySessionAsync (string session_address, int session_port, array< string > invitee_list)
	Send invite to list of users.

proto native void	SetMultiplayState (bool is_active)
	Notifiy about interactive multiplayer state.

void	OnSetActivity (EBiosError error)
	Callback function.

void	OnClearActivity (EBiosError error)
	Callback function.

void	OnGetGameplaySession (string session_address, int session_port)
	Callback function.

void	OnGetSessionError (EBiosError error)
	//! Callback function, not implemented

void	OnEnterGameplaySession (string session_address, int session_port, EBiosError error)
	Callback function.

void	OnLeaveGameplaySession (EBiosError error)
	Callback function.

void	OnShowInviteToGameplaySession (EBiosError error)
	Callback function.

void	OnInviteToGameplaySession (EBiosError error)
	Callback function.

array< string >	GetSessionPlayerList ()

void	GetSessionPlayerListEx (TStringArray outPlayerList)
	Native callback function to retrieve the session player list.

Protected Attributes
int	m_GetSessionAttempts

string	m_CurrentHandle

Detailed Description

Definition at line 1 of file biossessionservice.c.

Member Function Documentation

◆ ClearActivityAsync()

proto native EBiosError BiosSessionService::ClearActivityAsync ( )

protected

not implemented

Clears the current activity

The async result is returned in the OnClearActivity callback. Expected errors:

Returns: EBiosError indicating if the async operation is pending.

◆ EnterGameplaySessionAsync()

proto native EBiosError BiosSessionService::EnterGameplaySessionAsync	(	string	session_address,
		int	session_port )

protected

Enter a gameplay session.

The async result is returned in the OnEnterGameplaySession callback. Expected errors: LOGICAL - if the user is currently in an active gameplay session.

Parameters

session_address	server IP address.
session_port	server port.

Returns: EBiosError indicating if the async operation is pending.

◆ GetSessionAsync()

proto native EBiosError BiosSessionService::GetSessionAsync ( string join_handle )

protected

Gets a session from a join handle.

The async result is returned in the OnGetGameplaySession, OnGetLobbySession or OnGetSessionError callback, dependinng on the type of session, or error. Expected errors:

Parameters

join_handle the parsed join handle.

Returns: EBiosError indicating if the async operation is pending.

◆ GetSessionPlayerList()

array< string > BiosSessionService::GetSessionPlayerList ( )

protected

Definition at line 258 of file biossessionservice.c.

◆ GetSessionPlayerListEx()

void BiosSessionService::GetSessionPlayerListEx ( TStringArray outPlayerList )

protected

Native callback function to retrieve the session player list.

Parameters

outPlayerList Output list of players in the session.

Definition at line 267 of file biossessionservice.c.

◆ InviteToGameplaySessionAsync()

proto native EBiosError BiosSessionService::InviteToGameplaySessionAsync	(	string	session_address,
		int	session_port,
		array< string >	invitee_list )

protected

Send invite to list of users.

The async result is returned in the OnInviteToGameplaySession callback. The user must be inside the session. That means, OnEnterGameplaySession must be called with no errors.

Parameters

session_address	server IP address.
session_port	server port.
invitee_list	list of users to invite

Returns: EBiosError indicating if the async operation is pending.

◆ LeaveGameplaySessionAsync()

proto native EBiosError BiosSessionService::LeaveGameplaySessionAsync	(	string	session_address,
		int	session_port )

protected

Leave a gameplay session.

The async result is returned in the OnLeaveGameplaySession callback. If there is an unexpected error the state is cleared. Expected errors: ERR_NOT_FOUND - when attempting to leave a gameplay session the user is not part of. ERR_LOGICAL - when the user is not in a gameplay session.

Parameters

session_address	server IP address.
session_port	server port.

Returns: EBiosError indicating if the async operation is pending.

◆ OnClearActivity()

void BiosSessionService::OnClearActivity ( EBiosError error )

protected

Callback function.

Parameters

error error indicating success or fail of the async operation.

Definition at line 138 of file biossessionservice.c.

◆ OnEnterGameplaySession()

void BiosSessionService::OnEnterGameplaySession	(	string	session_address,
		int	session_port,
		EBiosError	error )

protected

Callback function.

Parameters

session_address	server IP address. Empty if failed.
session_port	server port. 0 if failed.
error	error indicating success or fail of the async operation.

Definition at line 220 of file biossessionservice.c.

◆ OnGetGameplaySession()

void BiosSessionService::OnGetGameplaySession	(	string	session_address,
		int	session_port )

protected

Callback function.

Parameters

session_address	server IP address.
session_port	server port.

Definition at line 147 of file biossessionservice.c.

◆ OnGetSessionError()

void BiosSessionService::OnGetSessionError ( EBiosError error )

protected

//! Callback function, not implemented

Callback function

Parameters

error error indicating fail of the async operation. Cannot be OK.

Definition at line 201 of file biossessionservice.c.

◆ OnInviteToGameplaySession()

void BiosSessionService::OnInviteToGameplaySession ( EBiosError error )

protected

Callback function.

Parameters

error indicating success or fail of the async operation.

Definition at line 253 of file biossessionservice.c.

◆ OnLeaveGameplaySession()

void BiosSessionService::OnLeaveGameplaySession ( EBiosError error )

protected

Callback function.

Parameters

error error indicating success or fail of the async operation.

Definition at line 236 of file biossessionservice.c.

◆ OnSessionPlayerListUpdate()

proto native void BiosSessionService::OnSessionPlayerListUpdate ( array< string > newPlayers )

protected

Alerts engine that players in current session have changed.

Parameters

newPlayers players that have just joined the server. When player joins a server, ALL players already on server count as new players.

◆ OnSetActivity()

void BiosSessionService::OnSetActivity ( EBiosError error )

protected

Callback function.

Parameters

error error indicating success or fail of the async operation.

Definition at line 129 of file biossessionservice.c.

◆ OnShowInviteToGameplaySession()

void BiosSessionService::OnShowInviteToGameplaySession ( EBiosError error )

protected

Callback function.

Parameters

error indicating success or fail of the async operation.

Definition at line 244 of file biossessionservice.c.

◆ SetGameplayActivityAsync()

proto native EBiosError BiosSessionService::SetGameplayActivityAsync	(	string	session_address,
		int	session_port )

protected

Sets the activity to a gameplay session.

The async result is returned in the OnSetActivity callback. Expected errors: ERR_NOT_FOUND - when attempting to set a gameplay session activity the user is not part of.

Parameters

session_address	server IP address.
session_port	server port.

Returns: EBiosError indicating if the async operation is pending.

◆ SetMultiplayState()

proto native void BiosSessionService::SetMultiplayState ( bool is_active )

protected

Notifiy about interactive multiplayer state.

◆ ShowInviteToGameplaySessionAsync()

proto native EBiosError BiosSessionService::ShowInviteToGameplaySessionAsync	(	string	session_address,
		int	session_port )

protected

Show system UI to invite friends to current gameplay session.

The async result is returned in the OnShowInviteToGameplaySession callback. On Xbox, if session with session_address and session_port does not exist, then xbox show message "We could not send the invite".

Parameters

session_address	server IP address.
session_port	server port.

Returns: EBiosError indicating if the async operation is pending.

◆ TryGetSession()

void BiosSessionService::TryGetSession ( string join_handle = "" )

protected

Gets a session from a join handle.

The async result is returned in the OnGetGameplaySession, OnGetLobbySession or OnGetSessionError callback, dependinng on the type of session, or error. Expected errors:

Parameters

join_handle the parsed join handle.

Returns: EBiosError indicating if the async operation is pending.

Definition at line 47 of file biossessionservice.c.

Member Data Documentation

◆ m_CurrentHandle

string BiosSessionService::m_CurrentHandle

protected

Definition at line 4 of file biossessionservice.c.

◆ m_GetSessionAttempts

int BiosSessionService::m_GetSessionAttempts

protected

Definition at line 3 of file biossessionservice.c.

The documentation for this class was generated from the following file:

Daten/3_game/services/biossessionservice.c

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ ClearActivityAsync()

◆ EnterGameplaySessionAsync()

◆ GetSessionAsync()

◆ GetSessionPlayerList()

◆ GetSessionPlayerListEx()

◆ InviteToGameplaySessionAsync()

◆ LeaveGameplaySessionAsync()

◆ OnClearActivity()

◆ OnEnterGameplaySession()

◆ OnGetGameplaySession()

◆ OnGetSessionError()

◆ OnInviteToGameplaySession()

◆ OnLeaveGameplaySession()

◆ OnSessionPlayerListUpdate()

◆ OnSetActivity()

◆ OnShowInviteToGameplaySession()

◆ SetGameplayActivityAsync()

◆ SetMultiplayState()

◆ ShowInviteToGameplaySessionAsync()

◆ TryGetSession()

Member Data Documentation

◆ m_CurrentHandle

◆ m_GetSessionAttempts