Класс BiosUserManager

Закрытые члены
proto native BiosUser	GetTitleInitiator ()
	Gets the initiatior of the title.
proto native EBiosError	GetUserList (array< ref BiosUser > user_list)
	Gets the currently present list of users.
proto native EBiosError	LogOnUserAsync (BiosUser user)
	Display a system dependant ui for log-on.
proto native EBiosError	PickUserAsync ()
	Display a system dependant account picket.
proto native EBiosError	ParseJoinAsync (string join_data)
	Parse the join data from from command line parameters.
proto native EBiosError	ParsePartyAsync (string party_data)
	Parse the party data from from command line parameters.
proto native bool	SelectUser (BiosUser user)
	Informs the engine about the current selected user.
proto native BiosUser	GetSelectedUser ()
	Returns the currently selected user.
proto native EBiosError	GetUserDatabaseIdAsync ()
	Call async function to get database ID.
bool	SelectUserEx (BiosUser user)
void	OnUserDatabaseId (string dbID, EBiosError error)
	Callback function.
void	OnUserLoggedOn (EBiosError error)
	Callback function.
void	OnUserPicked (BiosUser user, EBiosError error)
	Callback function.
void	OnLoggedOn (BiosUser user)
	Callback function.
void	OnLoggedOff (BiosUser user)
	Callback function.
void	OnSignedIn (BiosUser user)
	Callback function.
void	OnSignedOut (BiosUser user)
	Callback function.
void	OnJoin (EBiosJoinType type, BiosUser joiner, string handle, string joinee, EBiosError error)
	Callback function.
void	OnPartyHost (BiosUser host, array< string > invitee_list, EBiosError error)
	Callback function.
void	OnGameNameChanged (BiosUser user)
	Callback function.
BiosUser	GetUser (string user_id)

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

Методы

GetSelectedUser()

proto native BiosUser GetSelectedUser ( )

private

Returns the currently selected user.

Возвращает

BiosUser the selected user. May be NULL.

Используется в OnGameNameChanged(), OnLoggedOn(), OnSignedOut() и SelectUserEx().

GetTitleInitiator()

proto native BiosUser GetTitleInitiator ( )

private

Gets the initiatior of the title.

Возвращает

BiosUser the initiator. May be NULL.

GetUser()

BiosUser GetUser ( string user_id )

inlineprivate

    {
        array<ref BiosUser> user_list = new array<ref BiosUser>;
        GetUserList( user_list );
        foreach ( BiosUser user : user_list )
        {
            if ( user.GetUid() == user_id )
            {
                return user;
            }
        }
        return null;
    }

Перекрестные ссылки GetUserList().

GetUserDatabaseIdAsync()

proto native EBiosError GetUserDatabaseIdAsync ( )

private

Call async function to get database ID.

Возвращает

EBiosError indicating if the async operation is pending. If active user is not set, then return NOT_FOUND

GetUserList()

proto native EBiosError GetUserList ( array< ref BiosUser > user_list )

private

Gets the currently present list of users.

Fills in the array. Expected errors: BAD_PARAMETER - user_list is NULL,

Возвращает

EBiosError indicating if the operation is done.

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

LogOnUserAsync()

proto native EBiosError LogOnUserAsync ( BiosUser user )

private

Display a system dependant ui for log-on.

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

OnGameNameChanged()

void OnGameNameChanged ( BiosUser user )

inlineprivate

Callback function.

Called when display info of a signed in user changed.

Аргументы

user	the user affected by the change.

    {
        if ( user == GetSelectedUser() )
        {
            g_Game.SetPlayerName( user.GetName() );
            #ifdef PLATFORM_CONSOLE
                g_Game.SetPlayerGameName( user.GetName() );
            #endif
            if ( GetGame().GetUIManager().GetMenu() )
            {
                GetGame().GetUIManager().GetMenu().Refresh();
            }
        }
    }

Перекрестные ссылки g_Game, GetGame() и GetSelectedUser().

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

OnJoin()

void OnJoin ( EBiosJoinType type, BiosUser joiner, string handle, string joinee, EBiosError error )

inlineprivate

Callback function.

Called when a join is parsed or when a runtime join is accepted from the system UI.

Аргументы

type	the type of join. Undefined on error.
joiner	the user that is joining. NULL on error.
handle	join handle for a session. Empty on error.
joinee	uid of the user that is being joined. Empty on error.
error	indicating if parsing failed. OK if not a result of ParseJoinAsync.

    {
        if ( !OnlineServices.ErrorCaught( error ) )
        {
            OnlineServices.SetBiosUser( joiner );
            
            SelectUserEx( joiner );
            OnlineServices.SetSessionHandle( handle );
            
            if ( g_Game.GetGameState() == DayZGameState.IN_GAME )
            {
                g_Game.SetLoadState( DayZLoadState.JOIN_START );
                OnlineServices.GetSession();
            }
            else
            {
                if ( GetGame().GetUIManager() && GetGame().GetInput().IsActiveGamepadSelected() )
                {
                    GetGame().GetUIManager().CloseMenu( MENU_TITLE_SCREEN );
                    GetGame().GetInput().IdentifyGamepad( GamepadButton.BUTTON_NONE );
                }
                g_Game.SetLoadState( DayZLoadState.JOIN_START );
                g_Game.GamepadCheck();
            }
        }
        else
        {
            g_Game.DisconnectSessionEx(DISCONNECT_SESSION_FLAGS_JOIN);
        }
    }

Перекрестные ссылки DISCONNECT_SESSION_FLAGS_JOIN, OnlineServices::ErrorCaught(), g_Game, GetGame(), OnlineServices::GetSession(), MENU_TITLE_SCREEN, SelectUserEx(), OnlineServices::SetBiosUser() и OnlineServices::SetSessionHandle().

OnLoggedOff()

void OnLoggedOff ( BiosUser user )

inlineprivate

Callback function.

    {
        OnSignedOut( user );
    }

Перекрестные ссылки OnSignedOut().

OnLoggedOn()

void OnLoggedOn ( BiosUser user )

inlineprivate

Callback function.

    {
        if ( user && GetSelectedUser() == user )
            g_Game.SelectUser(GetGame().GetInput().GetUserGamepad(user));
    }

Перекрестные ссылки g_Game, GetGame() и GetSelectedUser().

OnPartyHost()

void OnPartyHost ( BiosUser host, array< string > invitee_list, EBiosError error )

inlineprivate

Callback function.

Called when a party is parsed or when a party is hosted from the system UI.

Аргументы

host	the user that is hosting the party. NULL on error.
invitee_list	list of party members.
error	indicating if parsing failed. OK if not a result of ParsePartyAsync.

    {
        #ifdef PLATFORM_PS4
        if (host)
        #endif
        {
            SelectUserEx(host);
            
        #ifdef PLATFORM_PS4
            if (!host.IsOnline())
        {
            LogOnUserAsync( host );
        }
        #endif
        }
 
 
        if (GetGame().GetUIManager())
        {
            GetGame().GetUIManager().CloseMenu(MENU_TITLE_SCREEN);
        }
        
        OnlineServices.SetPendingInviteList( invitee_list );
        if (g_Game.GetGameState() != DayZGameState.IN_GAME && g_Game.GetGameState() != DayZGameState.CONNECTING)
        {
            if (!GetGame().GetUIManager().GetMenu() || GetGame().GetUIManager().GetMenu().GetID() != MENU_MAIN)
            {
                GetGame().GetUIManager().EnterScriptedMenu(MENU_MAIN, GetGame().GetUIManager().GetMenu());
            }
            g_Game.SetGameState( DayZGameState.PARTY );
            g_Game.SetLoadState( DayZLoadState.PARTY_START );
            g_Game.GamepadCheck();
        }
    }

Перекрестные ссылки g_Game, GetGame(), GetID(), LogOnUserAsync(), MENU_MAIN, MENU_TITLE_SCREEN, SelectUserEx() и OnlineServices::SetPendingInviteList().

OnSignedIn()

void OnSignedIn ( BiosUser user )

inlineprivate

Callback function.

Called when a new user signed in

Аргументы

user	the user that signed in. Cannot be NULL.

    {
        
    }

OnSignedOut()

void OnSignedOut ( BiosUser user )

inlineprivate

Callback function.

Called when a new user signed out

Аргументы

user	the user that signed out. Cannot be NULL.

    {
        if ( user == GetSelectedUser() )
        {
            SelectUserEx( null );
            GetGame().GetInput().ResetActiveGamepad();
            g_Game.DisconnectSessionEx(DISCONNECT_SESSION_FLAGS_FORCE & ~DisconnectSessionFlags.SELECT_USER);
        }
    }

Перекрестные ссылки DISCONNECT_SESSION_FLAGS_FORCE, g_Game, GetGame(), GetSelectedUser() и SelectUserEx().

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

OnUserDatabaseId()

void OnUserDatabaseId ( string dbID, EBiosError error )

inlineprivate

Callback function.

Аргументы

dbID	user database ID. If something went wrong, then it is empty string.
error	indicating correct state.

    {
        if ( !OnlineServices.ErrorCaught( error ) )
        {
            g_Game.SetDatabaseID( dbID );
        }
    }

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

OnUserLoggedOn()

void OnUserLoggedOn ( EBiosError error )

inlineprivate

Callback function.

Аргументы

error

error indicating success or fail of the async operation.

    {
        if ( OnlineServices.ErrorCaught( error ) )
        {
            GetGame().GetInput().ResetActiveGamepad();
            g_Game.DisconnectSessionEx(DISCONNECT_SESSION_FLAGS_FORCE);
        }
    }

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

OnUserPicked()

void OnUserPicked ( BiosUser user, EBiosError error )

inlineprivate

Callback function.

Аргументы

user	picked user. NULL on fail.
error	error indicating success or fail of the async operation.

    {
        if ( !user )
        {
            GetGame().GetInput().ResetActiveGamepad();
            g_Game.GamepadCheck();
        }
        else if ( !OnlineServices.ErrorCaught( error ) )
        {
            if (SelectUserEx( user ))
            {
                if ( GetGame().GetMission() )
                    GetGame().GetMission().Reset();
                OnGameNameChanged( user );
                g_Game.SelectUser(GetGame().GetInput().GetUserGamepad(user));
            }
        }
    }

Перекрестные ссылки OnlineServices::ErrorCaught(), g_Game, GetGame(), OnGameNameChanged() и SelectUserEx().

ParseJoinAsync()

proto native EBiosError ParseJoinAsync ( string join_data )

private

Parse the join data from from command line parameters.

The async result is returned in the OnJoin callback. The OnJoin callback is called also during runtime when a join is accepted. Expected errors: BAD_PARAMETER - join_data could not be parsed,

Аргументы

join_data

the startup join data from command line parameters.

Возвращает

EBiosError indicating if the async operation is pending.

ParsePartyAsync()

proto native EBiosError ParsePartyAsync ( string party_data )

private

Parse the party data from from command line parameters.

The async result is returned in the OnPartyHost callback. The OnPartyHost callback is called also during runtime when a player hosts a game for the party. Expected errors: BAD_PARAMETER - join_data could not be parsed,

Аргументы

party_data

the startup party data from command line parameters.

Возвращает

EBiosError indicating if the async operation is pending.

PickUserAsync()

proto native EBiosError PickUserAsync ( )

private

Display a system dependant account picket.

Xbox: The async result is returned in the OnUserPicked callback.

Возвращает

EBiosError indicating if the async operation is pending.

SelectUser()

proto native bool SelectUser ( BiosUser user )

private

Informs the engine about the current selected user.

Must be called to ensure proper authentication etc.

Аргументы

user	the user to select.

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

SelectUserEx()

bool SelectUserEx ( BiosUser user )

inlineprivate

    {
        bool success = false;
        
        BiosUser selectedUser = GetSelectedUser();
        if (selectedUser && selectedUser != user && g_Game.GetGameState() != DayZGameState.MAIN_MENU)
        {
            success = SelectUser(user);
            g_Game.DisconnectSessionEx(DISCONNECT_SESSION_FLAGS_FORCE & ~DisconnectSessionFlags.SELECT_USER);
        }
        else
            success = SelectUser(user);
        
        if (!success)
        {
            NotificationSystem.AddNotification(NotificationType.GENERIC_ERROR, NotificationSystem.DEFAULT_TIME_DISPLAYED);
        }
        
        return success;
    }

Перекрестные ссылки NotificationSystem::AddNotification(), NotificationSystem::DEFAULT_TIME_DISPLAYED, DISCONNECT_SESSION_FLAGS_FORCE, g_Game, GetSelectedUser() и SelectUser().

Используется в OnJoin(), OnPartyHost(), OnSignedOut() и OnUserPicked().

---

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

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