Dayz Build 1.29.163047, Scripts Rev. 123548
Dayz Code Explorer by Zeroy
Loading...
Searching...
No Matches
BiosUserManager Class Reference

Private Member Functions

void CheckUserSwitchResult (BiosUser expectedUser)
proto native BiosUser GetSelectedUser ()
 Returns the currently selected user.
proto native BiosUser GetTitleInitiator ()
 Gets the initiatior of the title.
BiosUser GetUser (string user_id)
proto native EBiosError GetUserDatabaseIdAsync ()
 Call async function to get database ID.
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.
void OnGameNameChanged (BiosUser user)
 Callback function.
void OnJoin (EBiosJoinType type, BiosUser joiner, string handle, string joinee, EBiosError error)
 Callback function.
void OnLoggedOff (BiosUser user)
 Callback function.
void OnLoggedOn (BiosUser user)
 Callback function.
void OnPartyHost (BiosUser host, array< string > invitee_list, EBiosError error)
 Callback function.
void OnSignedIn (BiosUser user)
 Callback function.
void OnSignedOut (BiosUser user)
 Callback function.
void OnUserDatabaseId (string dbID, EBiosError error)
 Callback function.
void OnUserLoggedOn (EBiosError error)
 Callback function.
void OnUserPicked (BiosUser user, EBiosError error)
 Callback function.
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 EBiosError PickUserAsync ()
 Display a system dependant account picket.
proto native bool SelectUser (BiosUser user)
 Informs the engine about the current selected user.
bool SelectUserEx (BiosUser user)

Detailed Description

Definition at line 16 of file biosusermanager.c.

Member Function Documentation

◆ CheckUserSwitchResult()

void CheckUserSwitchResult ( BiosUser expectedUser)
inlineprivate

◆ GetSelectedUser()

◆ GetTitleInitiator()

proto native BiosUser GetTitleInitiator ( )
private

Gets the initiatior of the title.

Returns
BiosUser the initiator. May be NULL.

Referenced by CGame::ConnectLaunch(), CGame::MainMenuLaunch(), and CGame::MissionLaunch().

◆ GetUser()

BiosUser GetUser ( string user_id)
inlineprivate

Definition at line 316 of file biosusermanager.c.

References GetUserList().

◆ GetUserDatabaseIdAsync()

proto native EBiosError GetUserDatabaseIdAsync ( )
private

Call async function to get database ID.

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

Referenced by CGame::OnLoginTimeEvent(), and CGame::SelectGamepad().

◆ 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,

Returns
EBiosError indicating if the operation is done.

Referenced by OnlineServices::GetClientServices(), and GetUser().

◆ LogOnUserAsync()

proto native EBiosError LogOnUserAsync ( BiosUser user)
private

Display a system dependant ui for log-on.

Referenced by OnPartyHost(), and CGame::SelectUser().

◆ OnGameNameChanged()

void OnGameNameChanged ( BiosUser user)
inlineprivate

Callback function.

Called when display info of a signed in user changed.

Parameters
userthe user affected by the change.

Definition at line 301 of file biosusermanager.c.

References g_Game, BiosUser::GetName(), and GetSelectedUser().

Referenced by 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.

Parameters
typethe type of join. Undefined on error.
joinerthe user that is joining. NULL on error.
handlejoin handle for a session. Empty on error.
joineeuid of the user that is being joined. Empty on error.
errorindicating if parsing failed. OK if not a result of ParseJoinAsync.

Definition at line 221 of file biosusermanager.c.

References DISCONNECT_SESSION_FLAGS_JOIN, OnlineServices::ErrorCaught(), g_Game, OnlineServices::GetSession(), MENU_TITLE_SCREEN, SelectUserEx(), OnlineServices::SetBiosUser(), and OnlineServices::SetSessionHandle().

◆ OnLoggedOff()

void OnLoggedOff ( BiosUser user)
inlineprivate

Callback function.

Definition at line 179 of file biosusermanager.c.

References OnSignedOut().

◆ OnLoggedOn()

void OnLoggedOn ( BiosUser user)
inlineprivate

Callback function.

Definition at line 172 of file biosusermanager.c.

References g_Game, and 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.

Parameters
hostthe user that is hosting the party. NULL on error.
invitee_listlist of party members.
errorindicating if parsing failed. OK if not a result of ParsePartyAsync.

Definition at line 260 of file biosusermanager.c.

References g_Game, BiosUser::IsOnline(), LogOnUserAsync(), MENU_MAIN, MENU_TITLE_SCREEN, SelectUserEx(), and OnlineServices::SetPendingInviteList().

◆ OnSignedIn()

void OnSignedIn ( BiosUser user)
inlineprivate

Callback function.

Called when a new user signed in

Parameters
userthe user that signed in. Cannot be NULL.

Definition at line 190 of file biosusermanager.c.

◆ OnSignedOut()

void OnSignedOut ( BiosUser user)
inlineprivate

Callback function.

Called when a new user signed out

Parameters
userthe user that signed out. Cannot be NULL.

Definition at line 201 of file biosusermanager.c.

References DISCONNECT_SESSION_FLAGS_FORCE, g_Game, GetSelectedUser(), and SelectUserEx().

Referenced by OnLoggedOff().

◆ OnUserDatabaseId()

void OnUserDatabaseId ( string dbID,
EBiosError error )
inlineprivate

Callback function.

Parameters
dbIDuser database ID. If something went wrong, then it is empty string.
errorindicating correct state.

Definition at line 125 of file biosusermanager.c.

References OnlineServices::ErrorCaught(), and g_Game.

◆ OnUserLoggedOn()

void OnUserLoggedOn ( EBiosError error)
inlineprivate

Callback function.

Parameters
errorerror indicating success or fail of the async operation.

Definition at line 137 of file biosusermanager.c.

References DISCONNECT_SESSION_FLAGS_FORCE, OnlineServices::ErrorCaught(), and g_Game.

◆ OnUserPicked()

void OnUserPicked ( BiosUser user,
EBiosError error )
inlineprivate

Callback function.

Parameters
userpicked user. NULL on fail.
errorerror indicating success or fail of the async operation.

Definition at line 151 of file biosusermanager.c.

References OnlineServices::ErrorCaught(), g_Game, mission, OnGameNameChanged(), and 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,

Parameters
join_datathe startup join data from command line parameters.
Returns
EBiosError indicating if the async operation is pending.

Referenced by CGame::JoinLaunch().

◆ 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,

Parameters
party_datathe startup party data from command line parameters.
Returns
EBiosError indicating if the async operation is pending.

Referenced by CGame::PartyLaunch().

◆ PickUserAsync()

proto native EBiosError PickUserAsync ( )
private

Display a system dependant account picket.

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

Returns
EBiosError indicating if the async operation is pending.

Referenced by CGame::SelectUser().

◆ SelectUser()

proto native bool SelectUser ( BiosUser user)
private

Informs the engine about the current selected user.

Must be called to ensure proper authentication etc.

Parameters
userthe user to select.

Referenced by SelectUserEx().

◆ SelectUserEx()


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