UTGame.UTUIFrontEnd_LoginScreen

Extends

UTUIFrontEnd_CustomScreen

Modifiers

Config ( Game ) native ( UIFrontEnd )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Profile login screen for UT3.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIScene
         |   
         +-- UTGame.UTUIScene
            |   
            +-- UTGame.UTUIFrontEnd
               |   
               +-- UTGame.UTUIFrontEnd_CustomScreen
                  |   
                  +-- UTGame.UTUIFrontEnd_LoginScreen

Delegates Summary
		OnCancelSelection (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))

Functions Summary
		CheckLoginProperties ()
		ClearLoginDelegates ()))
	bool	HandleInputKey (const out InputEventParameters EventParms ))
		OnAutoLoginCheckBox_ValueChanged (UIObject Sender, int PlayerIndex))
	bool	OnButtonBar_Cancel (UIScreenObject InButton, int InPlayerIndex))
	bool	OnButtonBar_CreateProfile (UIScreenObject InButton, int InPlayerIndex))
	bool	OnButtonBar_Login (UIScreenObject InButton, int InPlayerIndex))
	bool	OnButtonBar_PlayOffline (UIScreenObject InButton, int InPlayerIndex))
	bool	OnButtonBar_ShowKeyboard (UIScreenObject InButton, int InPlayerIndex))
		OnCancel ()))
		OnCreateProfile ()))
		OnLocalLoginCheckBox_ValueChanged (UIObject Sender, int PlayerIndex))
		OnLogin (optional bool bLocalLogin=false))
		OnLoginCancelled ()))
		OnLoginCancelled_Closed ()))
		OnLoginChange ()))
		OnLoginChange_Closed ()))
		OnLoginFailed (byte LocalUserNum, OnlineServerConnectionStatus ErrorCode))
		OnLoginFailed_Closed ()))
		OnMainRegion_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq))
		OnPlayOffline ()))
		OnSavePasswordCheckBox_ValueChanged (UIObject Sender, int PlayerIndex))
		OnShowKeyboard ()))
	bool	OnSubmitText (UIEditBox Sender, int PlayerIndex ))
		PostInitialize ()))
		SetupButtonBar ()))

AutoLoginCheckBox Source code

Reference to the autologin checkbox.

bAutoLogin Source code

Whether or not to autologin for the user.

bLoginOnShow Source code

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

bSavePassword Source code

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

CreateProfileScene Source code

LocalLoginCheckBox Source code

Reference to the local login checkbox.

LoginErrorCode Source code

MessageBoxReference Source code

PasswordEditBox Source code

PlayerNames Source code

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

SavePasswordCheckBox Source code

Reference to the save password checkbox.

UserNameEditBox Source code

OnCancelSelection Source code

CheckLoginProperties Source code

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

ClearLoginDelegates Source code

Clears login delegates.

HandleInputKey Source code

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.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

OnAutoLoginCheckBox_ValueChanged Source code

Callback for when the autologin checkbox changes value.
@param Sender Object that sent the event
@param PlayerIndex Index of the player that performed the action.

OnButtonBar_Cancel Source code

Buttonbar Callbacks.

OnButtonBar_CreateProfile Source code

OnButtonBar_Login Source code

OnButtonBar_PlayOffline Source code

OnButtonBar_ShowKeyboard Source code

OnCancel Source code

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

OnCreateProfile Source code

Displays the account creation scene

OnLocalLoginCheckBox_ValueChanged Source code

Callback for when the local login checkbox changes value.
@param Sender Object that sent the event
@param PlayerIndex Index of the player that performed the action.

OnLogin Source code

Tries to login the user

OnLoginCancelled Source code

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

OnLoginCancelled_Closed Source code

Callback for when the login cancelled messagebox has closed.

OnLoginChange Source code

Delegate used in login notifications

OnLoginChange_Closed Source code

Callback for when the login message closes for login change.

OnLoginFailed Source code

Delegate used in notifying the UI/game that the manual login failed
@param LocalUserNum the controller number of the associated user
@param ErrorCode the async error code that occurred

OnLoginFailed_Closed Source code

Callback for when the login message closes.

OnMainRegion_Show_UIAnimEnd Source code

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

OnPlayOffline Source code

Play offline callback, logs the user in offline.

OnSavePasswordCheckBox_ValueChanged Source code

Callback for when the savepassword checkbox changes value.
@param Sender Object that sent the event
@param PlayerIndex Index of the player that performed the action.

OnShowKeyboard Source code

Shows the online keyboard.

OnSubmitText Source code

Called when the user presses enter (or any other action bound to UIKey_SubmitText) while this editbox has focus.
@param Sender the editbox that is submitting text
@param 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.
@return if TRUE, the editbox will clear the existing value of its textbox.

PostInitialize Source code

PostInitialize event - Sets delegates for the scene.

SetupButtonBar Source code

Sets up the scene's button bar.

defaultproperties
{
   CreateProfileScene="UI_Scenes_FrontEnd.Scenes.CreateProfile"
   bSavePassword=True
   bAutoLogin=True
   PlayerNames(0)="HellDragon"
   PlayerNames(1)=
   bSaveSceneValuesOnClose=False
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_CustomScreen:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIFrontEnd_CustomScreen:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIFrontEnd_LoginScreen"
   ObjectArchetype=UTUIFrontEnd_CustomScreen'UTGame.Default__UTUIFrontEnd_CustomScreen'
}