Класс BiosSessionService

Защищенные члены
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 ()

Защищенные данные
int	m_GetSessionAttempts
string	m_CurrentHandle

Подробное описание

Методы

ClearActivityAsync()

proto native EBiosError ClearActivityAsync ( )

protected

not implemented

Clears the current activity

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

Возвращает

EBiosError indicating if the async operation is pending.

EnterGameplaySessionAsync()

proto native EBiosError 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.

Аргументы

session_address	server IP address.
session_port	server port.

Возвращает

EBiosError indicating if the async operation is pending.

GetSessionAsync()

proto native EBiosError 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:

Аргументы

join_handle

the parsed join handle.

Возвращает

EBiosError indicating if the async operation is pending.

Используется в TryGetSession().

GetSessionPlayerList()

array< string > GetSessionPlayerList ( )

inlineprotected

    {
        return ClientData.GetSimplePlayerList();
    }

Перекрестные ссылки ClientData::GetSimplePlayerList().

InviteToGameplaySessionAsync()

proto native EBiosError 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.

Аргументы

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

Возвращает

EBiosError indicating if the async operation is pending.

Используется в OnEnterGameplaySession().

LeaveGameplaySessionAsync()

proto native EBiosError 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.

Аргументы

session_address	server IP address.
session_port	server port.

Возвращает

EBiosError indicating if the async operation is pending.

OnClearActivity()

void OnClearActivity ( EBiosError error )

inlineprotected

Callback function.

Аргументы

error

error indicating success or fail of the async operation.

    {
    }

OnEnterGameplaySession()

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

inlineprotected

Callback function.

Аргументы

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.

    {
        if ( !OnlineServices.ErrorCaught( error ) )
        {
            SetGameplayActivityAsync( session_address, session_port );
            if ( OnlineServices.GetPendingInviteList() )
                InviteToGameplaySessionAsync( session_address, session_port, OnlineServices.GetPendingInviteList() );
            
            //OnlineServices.GetCurrentServerInfo(session_address, session_port);
        }
    }

Перекрестные ссылки OnlineServices::ErrorCaught(), OnlineServices::GetPendingInviteList(), InviteToGameplaySessionAsync() и SetGameplayActivityAsync().

OnGetGameplaySession()

void OnGetGameplaySession ( string session_address, int session_port )

inlineprotected

Callback function.

Аргументы

session_address	server IP address.
session_port	server port.

    {   
        m_GetSessionAttempts = 0;
        switch (g_Game.GetGameState())
        {
            case DayZGameState.IN_GAME:
            {
                string addr;
                int port;
                bool found = GetGame().GetHostAddress( addr, port );
                if (addr != session_address || port != session_port )
                {
                    if (found)
                    {
                        OnlineServices.SetInviteServerInfo( session_address, session_port );
                        g_Game.GetUIManager().CloseAll();
                        if (!g_Game.GetUIManager().EnterScriptedMenu( MENU_INVITE_TIMER, null ))
                        {
                            NotificationSystem.AddNotification( NotificationType.CONNECT_FAIL_GENERIC, NotificationSystem.DEFAULT_TIME_DISPLAYED );
                        }
                    }
                    else
                    {
                        NotificationSystem.AddNotification( NotificationType.JOIN_FAIL_GET_SESSION, NotificationSystem.DEFAULT_TIME_DISPLAYED );
                    }
                }
                else
                {
                    NotificationSystem.AddNotification( NotificationType.INVITE_FAIL_SAME_SERVER, NotificationSystem.DEFAULT_TIME_DISPLAYED, "#ps4_already_in_session" );
                }
                break;
            }
            case DayZGameState.CONNECTING:
            {
                g_Game.DisconnectSessionEx(DISCONNECT_SESSION_FLAGS_FORCE);
                // Intentionally no break, fall through to connecting
            }
            default:
            {
                g_Game.ConnectFromJoin( session_address, session_port );
                break;
            }
        }
    }

Перекрестные ссылки NotificationSystem::AddNotification(), NotificationSystem::DEFAULT_TIME_DISPLAYED, DISCONNECT_SESSION_FLAGS_FORCE, g_Game, GetGame(), m_GetSessionAttempts, MENU_INVITE_TIMER и OnlineServices::SetInviteServerInfo().

OnGetSessionError()

void OnGetSessionError ( EBiosError error )

inlineprotected

//! Callback function, not implemented

Callback function

Аргументы

error

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

    {
        OnlineServices.ErrorCaught( error );
        m_GetSessionAttempts++;
        
        #ifdef PLATFORM_XBOX
            GetGame().GetCallQueue( CALL_CATEGORY_SYSTEM ).CallLater( TryGetSession, 100, false, "" );
        #endif
        #ifdef PLATFORM_PS4
            g_Game.DisconnectSessionEx(DISCONNECT_SESSION_FLAGS_JOIN);
        #endif      
    }

Перекрестные ссылки CALL_CATEGORY_SYSTEM, DISCONNECT_SESSION_FLAGS_JOIN, OnlineServices::ErrorCaught(), g_Game, GetGame(), m_GetSessionAttempts и TryGetSession().

OnInviteToGameplaySession()

void OnInviteToGameplaySession ( EBiosError error )

inlineprotected

Callback function.

Аргументы

error

indicating success or fail of the async operation.

    {
 
    }

OnLeaveGameplaySession()

void OnLeaveGameplaySession ( EBiosError error )

inlineprotected

Callback function.

Аргументы

error

error indicating success or fail of the async operation.

    {
    }

OnSessionPlayerListUpdate()

proto native void OnSessionPlayerListUpdate ( array< string > newPlayers )

protected

Alerts engine that players in current session have changed.

Аргументы

newPlayers

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

OnSetActivity()

void OnSetActivity ( EBiosError error )

inlineprotected

Callback function.

Аргументы

error

error indicating success or fail of the async operation.

    {
        OnlineServices.ErrorCaught( error );
    }

Перекрестные ссылки OnlineServices::ErrorCaught().

OnShowInviteToGameplaySession()

void OnShowInviteToGameplaySession ( EBiosError error )

inlineprotected

Callback function.

Аргументы

error

indicating success or fail of the async operation.

    {
        OnlineServices.ErrorCaught( error );
    }

Перекрестные ссылки OnlineServices::ErrorCaught().

SetGameplayActivityAsync()

proto native EBiosError 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.

Аргументы

session_address	server IP address.
session_port	server port.

Возвращает

EBiosError indicating if the async operation is pending.

Используется в OnEnterGameplaySession().

SetMultiplayState()

proto native void SetMultiplayState ( bool is_active )

protected

Notifiy about interactive multiplayer state.

ShowInviteToGameplaySessionAsync()

proto native EBiosError 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".

Аргументы

session_address	server IP address.
session_port	server port.

Возвращает

EBiosError indicating if the async operation is pending.

TryGetSession()

void TryGetSession ( string join_handle = "" )

inlineprotected

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:

Аргументы

join_handle

the parsed join handle.

Возвращает

EBiosError indicating if the async operation is pending.

    {
        if ( join_handle != "" )
        {
            m_GetSessionAttempts    = 0;
            m_CurrentHandle         = join_handle;
        }
        
        if ( m_GetSessionAttempts < 10 )
            GetSessionAsync( m_CurrentHandle );
        else
            g_Game.DisconnectSessionEx(DISCONNECT_SESSION_FLAGS_JOIN);
    }

Перекрестные ссылки DISCONNECT_SESSION_FLAGS_JOIN, g_Game, GetSessionAsync(), m_CurrentHandle и m_GetSessionAttempts.

Используется в OnGetSessionError().

Поля

m_CurrentHandle

string m_CurrentHandle

protected

Используется в TryGetSession().

m_GetSessionAttempts

int m_GetSessionAttempts

protected

Используется в OnGetGameplaySession(), OnGetSessionError() и TryGetSession().

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/3_Game/Services/BiosSessionService.c