UE3:UTUIFrontEnd_CustomScreen (UT3)

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

Package: 

UTGame

Direct subclasses:

UTUIScene_SendFriendRequest, UTUIScene_SendOnlineMessage, UTUIFrontEnd_CreateProfile, UTUIFrontEnd_CDKey, UTUIFrontEnd_LoginScreen

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

Custom Scene for UT3, contains a description label and an automated way of providing descriptions for widgets.

Properties

bIsPasswordKeyboard

Type: bool

Modifiers: transient

Whether or not the keyboard being displayed is a password keyboard.

DescriptionLabel

Type: UILabel

Modifiers: transient

DescriptionMap

Type: array<DescriptionMapping>

Modifiers: transient

KeyboardTargetEditBox

Type: UIEditBox

Modifiers: transient

Target editbox for the onscreen keyboard, if any.

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Structs

DescriptionMapping

Modifiers: native

Mapping of widget tag to field description.

name WidgetTag 

string DataStoreMarkup 

Functions

Static functions

StripInvalidUsernameCharacters

static function string StripInvalidUsernameCharacters (string Username)

Strips any characters which are deemed invalid for profile names from the specified username.

Parameters:

• Username - the username to strip invalid characters from.

Returns:

the username with all invalid characters stripped.

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

Other instance functions

OnKeyboardInputComplete

function OnKeyboardInputComplete (bool bWasSuccessful)

Delegate used when the keyboard input request has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnNotifyActiveStateChanged

function OnNotifyActiveStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState)

Callback for when the object's active state changes.

ShowKeyboard

function ShowKeyboard (UIEditBox InTargetEditBox, string Title, optional string Message, optional bool bPassword, optional bool bShouldValidate, optional string DefaultText, optional int MaxLength)

Shows the on screen keyboard.