UE3:UTUIFrontEnd_LoginScreen (UT3)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_CustomScreen >> UTUIFrontEnd_LoginScreen

Package: 

UTGame

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Profile login screen for UT3.

Properties

AutoLoginCheckBox

Type: UICheckbox

Modifiers: transient

Reference to the autologin checkbox.

bAutoLogin

Type: bool

Modifiers: config

Whether or not to autologin for the user.

bLoginOnShow

Type: bool

Modifiers: transient

if TRUE, logic procedure will begin automatically as soon as the menu completes its opening animation

bSavePassword

Type: bool

Modifiers: config

Whether or not to autofill in the password field for the user.

Default value: True

CreateProfileScene

Type: string

Default value: "UI_Scenes_FrontEnd.Scenes.CreateProfile"

LocalLoginCheckBox

Type: UICheckbox

Modifiers: transient

Reference to the local login checkbox.

LoginErrorCode

Type: OnlineSubsystem.EOnlineServerConnectionStatus

Modifiers: transient

MessageBoxReference

Type: UTUIScene_MessageBox

Modifiers: transient

PasswordEditBox

Type: UIEditBox

Modifiers: transient

PlayerNames

Type: array<string>

Modifiers: config

Array of player names that have logged in previously on this machine.

SavePasswordCheckBox

Type: UICheckbox

Modifiers: transient

Reference to the save password checkbox.

UserNameEditBox

Type: UIEditBox

Modifiers: transient

Default values

Property	Value
bSaveSceneValuesOnClose	False

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd_CustomScreen.SceneEventComponent

No new values.

Delegates

OnCancelSelection

delegate OnCancelSelection (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

Functions

Native functions

CheckLoginProperties

native function CheckLoginProperties ()

Checks to see if we should autopopuplate the password box or autologin.

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd_CustomScreen.PostInitialize

PostInitialize event - Sets delegates for the scene.

Other instance functions

ClearLoginDelegates

function ClearLoginDelegates ()

Clears login delegates.

HandleInputKey

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTUIFrontEnd.HandleInputKey

Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.)

Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8).

This delegate is called BEFORE kismet is given a chance to process the input.

Parameters:

• EventParms - information about the input event.

Returns:

TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

OnAutoLoginCheckBox_ValueChanged

function OnAutoLoginCheckBox_ValueChanged (UIObject Sender, int PlayerIndex)

Callback for when the autologin checkbox changes value.

Parameters:

• Sender - Object that sent the event
• PlayerIndex - Index of the player that performed the action.

OnButtonBar_Cancel

function bool OnButtonBar_Cancel (UIScreenObject InButton, int InPlayerIndex)

Buttonbar Callbacks.

OnButtonBar_CreateProfile

function bool OnButtonBar_CreateProfile (UIScreenObject InButton, int InPlayerIndex)

OnButtonBar_Login

function bool OnButtonBar_Login (UIScreenObject InButton, int InPlayerIndex)

OnButtonBar_PlayOffline

function bool OnButtonBar_PlayOffline (UIScreenObject InButton, int InPlayerIndex)

OnButtonBar_ShowKeyboard

function bool OnButtonBar_ShowKeyboard (UIScreenObject InButton, int InPlayerIndex)

OnCancel

function OnCancel ()

Callback for when the user wants to back out of this screen.

OnCreateProfile

function OnCreateProfile ()

Displays the account creation scene

OnLocalLoginCheckBox_ValueChanged

function OnLocalLoginCheckBox_ValueChanged (UIObject Sender, int PlayerIndex)

Callback for when the local login checkbox changes value.

Parameters:

• Sender - Object that sent the event
• PlayerIndex - Index of the player that performed the action.

OnLogin

function OnLogin (optional bool bLocalLogin)

Tries to login the user

OnLoginCancelled

function OnLoginCancelled ()

Delegate used to notify when a login request was cancelled by the user

OnLoginCancelled_Closed

function OnLoginCancelled_Closed ()

Callback for when the login cancelled messagebox has closed.

OnLoginChange

function OnLoginChange ()

Delegate used in login notifications

OnLoginChange_Closed

function OnLoginChange_Closed ()

Callback for when the login message closes for login change.

OnLoginFailed

function OnLoginFailed (byte LocalUserNum, OnlineSubsystem.EOnlineServerConnectionStatus ErrorCode)

Delegate used in notifying the UI/game that the manual login failed

Parameters:

• LocalUserNum - the controller number of the associated user
• ErrorCode - the async error code that occurred

OnLoginFailed_Closed

function OnLoginFailed_Closed ()

Callback for when the login message closes.

OnMainRegion_Show_UIAnimEnd

function OnMainRegion_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)

Overrides: UTUIFrontEnd.OnMainRegion_Show_UIAnimEnd

Callback for when the show animation has completed for this scene.

OnPlayOffline

function OnPlayOffline ()

Play offline callback, logs the user in offline.

OnSavePasswordCheckBox_ValueChanged

function OnSavePasswordCheckBox_ValueChanged (UIObject Sender, int PlayerIndex)

Callback for when the savepassword checkbox changes value.

Parameters:

• Sender - Object that sent the event
• PlayerIndex - Index of the player that performed the action.

OnShowKeyboard

function OnShowKeyboard ()

Shows the online keyboard.

OnSubmitText

function bool OnSubmitText (UIEditBox Sender, int PlayerIndex)

Called when the user presses enter (or any other action bound to UIKey_SubmitText) while this editbox has focus.

Parameters:

• Sender - the editbox that is submitting text
• PlayerIndex - the index of the player that generated the call to SetValue; used as the PlayerIndex when activating UIEvents; if not specified, the value of GetBestPlayerIndex() is used instead.

Returns:

if TRUE, the editbox will clear the existing value of its textbox.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Sets up the scene's button bar.