Difference between revisions of "UE3:UTUIScene InputBox (UDK)"

Revision as of 06:12, 17 January 2010 (edit) (Talk) ← Older edit	Latest revision as of 06:02, 17 January 2010 (edit) (undo) Wormbo (Talk | contribs) m (1 revision: class descriptions for UDK January update (part 8))
(No difference)

---

Latest revision as of 06:02, 17 January 2010

Package: 

UTGame

This class in other games:

UT3

This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

Generic Message Box Scene for UT3

Properties[edit]

bIsPasswordKeyboard[edit]

Type: bool

Modifiers: transient

Whether or not this is a password input box.

InputEditbox[edit]

Type: UIEditBox

Modifiers: transient

Reference to the editbox for the inputbox.

Subobjects[edit]

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIScene_MessageBox.WidgetEventComponent

No new values.

Functions[edit]

Events[edit]

PostInitialize[edit]

Overrides: UTUIScene_MessageBox.PostInitialize

Sets delegates for the scene.

Other instance functions[edit]

DisplayAcceptCancelBox[edit]

Overrides: UTUIScene_MessageBox.DisplayAcceptCancelBox

Displays a message box that has an accept and cancel button.

Parameters:

• Message - Message for the message box. Should be datastore markup.
• Title - Title for the message box. Should be datastore markup.
• InSelectionDelegate - Delegate to call when the user dismisses the message box.

GetValue[edit]

Returns:

string Returns the value of the input box.

OnKeyboardInputComplete[edit]

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

OnSubmitText[edit]

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.

OptionSelected[edit]

Overrides: UTUIScene_MessageBox.OptionSelected

Called when a user has chosen one of the possible options available to them. Begins hiding the dialog and calls the On

Parameters:

• OptionIdx - Index of the selection option.
• PlayerIndex - Index of the player that selected the option.

SetPasswordMode[edit]

Sets the flag indicating whether this input box is for a password.

ShowKeyboard[edit]

Shows the on screen keyboard.