DIFF

class BiosSessionServiceSource

Members 2

protected int m_GetSessionAttempts
string m_CurrentHandle
Referenced by TryGetSession()

Methods 20

proto native EBiosError EnterGameplaySessionAsync(string session_address, int session_port)

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

session_address
server IP address.
session_port
server port.

Returns: EBiosError indicating if the async operation is pending.

proto native EBiosError LeaveGameplaySessionAsync(string session_address, int session_port)

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.

session_address
server IP address.
session_port
server port.

Returns: EBiosError indicating if the async operation is pending.

proto native void OnSessionPlayerListUpdate(array<string> newPlayers)
newPlayers
players that have just joined the server. When player joins a server, ALL players already on server count as new players.
void TryGetSession(string join_handle = "")

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

join_handle
the parsed join handle.

Returns: EBiosError indicating if the async operation is pending.

proto native EBiosError GetSessionAsync(string join_handle)

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

join_handle
the parsed join handle.

Returns: EBiosError indicating if the async operation is pending.

Referenced by TryGetSession()
proto native EBiosError SetGameplayActivityAsync(string session_address, int session_port)

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.

session_address
server IP address.
session_port
server port.

Returns: EBiosError indicating if the async operation is pending.

proto native EBiosError ClearActivityAsync()

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

Returns: EBiosError indicating if the async operation is pending.

proto native EBiosError ShowInviteToGameplaySessionAsync(string session_address, int session_port)

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".

session_address
server IP address.
session_port
server port.

Returns: EBiosError indicating if the async operation is pending.

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

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.

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.

proto native void SetMultiplayState(bool is_active)

Notifiy about interactive multiplayer state

void OnSetActivity(EBiosError error)
error
error indicating success or fail of the async operation.
void OnClearActivity(EBiosError error)
error
error indicating success or fail of the async operation.
void OnGetSessionError(EBiosError error)
error
error indicating fail of the async operation. Cannot be OK.
void OnEnterGameplaySession(string session_address, int session_port, EBiosError error)
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.
void OnLeaveGameplaySession(EBiosError error)
error
error indicating success or fail of the async operation.
void OnShowInviteToGameplaySession(EBiosError error)
error
indicating success or fail of the async operation.
void OnInviteToGameplaySession(EBiosError error)
error
indicating success or fail of the async operation.
array<string> GetSessionPlayerList()
void GetSessionPlayerListEx(TStringArray outPlayerList)
outPlayerList
Output list of players in the session.