I'm a doctor, not a mechanic

UE3:OnlineAccountInterface (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Revision as of 16:11, 17 May 2008 by Wormbo (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UT3 Interface >> OnlineAccountInterface

Contents
Package: 
Engine
Known implementing classes:
OnlineSubsystemGameSpy
This interface in other games:
UDK
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

This interface provides account creation and enumeration functions

[edit] Delegates

[edit] 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

[edit] Instance functions

[edit] 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

[edit] ClearCreateOnlineAccountCompletedDelegate

function ClearCreateOnlineAccountCompletedDelegate (delegate<OnCreateOnlineAccountCompleted> AccountCreateDelegate)

Removes the specified delegate from the notification list

Parameters:

  • AccountCreateDelegate - the delegate to use for notifications

[edit] 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

[edit] 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

[edit] 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

[edit] 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

[edit] IsKeyValid

function bool IsKeyValid ()

Returns:

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

[edit] 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

[edit] 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
Retrieved from "http://wiki.beyondunreal.com/UE3:OnlineAccountInterface_(UT3)"