UE3:OnlineAccountInterface (UT3)

Interface >> OnlineAccountInterface

Package: 

Engine

Known implementing classes:

OnlineSubsystemGameSpy

This interface in other games:

UDK

This interface provides account creation and enumeration functions

Delegates

OnCreateOnlineAccountCompleted

delegate OnCreateOnlineAccountCompleted (OnlineSubsystem.EOnlineAccountCreateStatus ErrorStatus)

Delegate used in notifying the UI/game that the account creation completed

Parameters:

• ErrorStatus - whether the account created successfully or not

Instance functions

AddCreateOnlineAccountCompletedDelegate

function AddCreateOnlineAccountCompletedDelegate (delegate<OnCreateOnlineAccountCompleted> AccountCreateDelegate)

Sets the delegate used to notify the gameplay code that account creation completed

Parameters:

• AccountCreateDelegate - the delegate to use for notifications

ClearCreateOnlineAccountCompletedDelegate

function ClearCreateOnlineAccountCompletedDelegate (delegate<OnCreateOnlineAccountCompleted> AccountCreateDelegate)

Removes the specified delegate from the notification list

Parameters:

• AccountCreateDelegate - the delegate to use for notifications

CreateLocalAccount

function bool CreateLocalAccount (string UserName, optional string Password)

Creates a non-networked account on the local system. Password is only used when supplied. Otherwise the account is not secured.

Parameters:

• UserName - the unique nickname of the account
• Password - the password securing the account

Returns:

true if the account was created, false otherwise

CreateOnlineAccount

function bool CreateOnlineAccount (string UserName, string Password, string EmailAddress, optional string ProductKey)

Creates a network enabled account on the online service

Parameters:

• UserName - the unique nickname of the account
• Password - the password securing the account
• EmailAddress - the address used to send password hints to
• ProductKey - the unique id for this installed product

Returns:

true if the account was created, false otherwise

DeleteLocalAccount

function bool DeleteLocalAccount (string UserName, optional string Password)

Deletes a local account if the password matches

Parameters:

• UserName - the unique nickname of the account
• Password - the password securing the account

Returns:

true if the account was deleted, false otherwise

GetLocalAccountNames

function bool GetLocalAccountNames (out array<string> Accounts)

Fetches a list of local accounts

Parameters:

• Accounts - the array that is populated with the accounts

Returns:

true if the list was read, false otherwise

IsKeyValid

function bool IsKeyValid ()

Returns:

true if the product key is valid, false if it is invalid

RenameLocalAccount

function bool RenameLocalAccount (string NewUserName, string OldUserName, optional string Password)

Changes the name of a local account

Parameters:

• UserName - the unique nickname of the account
• Password - the password securing the account

Returns:

true if the account was renamed, false otherwise

SaveKey

function bool SaveKey (string ProductKey)

Saves the product key

Parameters:

• ProductKey - the product key the user entered

Returns:

true if the key was stored successfully, false otherwise