UE3:ConsoleEntry (UDK)

Object >> UIRoot >> UIScreenObject >> UIObject >> ConsoleEntry

Package:

Engine

This class in other games:

UT3

Temporary widget for representing the region that displays the text currently being typed into the console

Constants

ConsolePromptText

Value: "(> "

Properties

Property group 'ConsoleEntry'

bRenderCursor

Type: bool

controls whether the underline cursor is rendered

Internal variables

ConsolePromptBackground

Type: UIImage

Default value: UIImage'Engine.Default__ConsoleEntry:ConsolePromptBackgroundTemplate'

ConsolePromptLabel

Type: UILabel

displays the text that is currently being typed

Default value: UILabel'Engine.Default__ConsoleEntry:ConsolePromptTemplate'

CursorPosition

Type: int

Modifiers: transient

the current position of the cursor in InputBox's string

InputBox

Type: UIEditBox

Default value: UIEditBox'Engine.Default__ConsoleEntry:InputBoxTemplate'

LowerConsoleBorder

Type: UIImage

Default value: UIImage'Engine.Default__ConsoleEntry:LowerConsoleBorderTemplate'

UpperConsoleBorder

Type: UIImage

Default value: UIImage'Engine.Default__ConsoleEntry:UpperConsoleBorderTemplate'

Default values

Property	Value
bSupportsPrimaryStyle	False
Children[0]	UIEditBox'Engine.Default__ConsoleEntry:InputBoxTemplate'
Children[1]	UIImage'Engine.Default__ConsoleEntry:ConsolePromptBackgroundTemplate'
Children[2]	UILabel'Engine.Default__ConsoleEntry:ConsolePromptTemplate'
Children[3]	UIImage'Engine.Default__ConsoleEntry:LowerConsoleBorderTemplate'
Children[4]	UIImage'Engine.Default__ConsoleEntry:UpperConsoleBorderTemplate'
DefaultStates[2]	Class'Engine.UIState_Focused'
PrimaryStyle	Member Value DefaultStyleTag 'ConsoleStyle'
WidgetTag	'ConsoleEntry'

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UIObject.WidgetEventComponent

No new values.

Functions

Events

AddedChild

event AddedChild (UIScreenObject WidgetOwner, UIObject NewChild)

Overrides: UIScreenObject.AddedChild

(Description copied from UIScreenObject.AddedChild)
Called immediately after a child has been added to this screen object.

Parameters:

• WidgetOwner - the screen object that the NewChild was added as a child for
• NewChild - the widget that was added

PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Called after this screen object's children have been initialized. While the Initialized event is only called when a widget is initialized for the first time, PostInitialize() will be called every time this widget receives a call to Initialize(), even if the widget was already initialized. Examples would be reparenting a widget.

RemovedChild

event RemovedChild (UIScreenObject WidgetOwner, UIObject OldChild, optional array<UIObject> ExclusionSet)

Overrides: UIScreenObject.RemovedChild

Called immediately after a child has been removed from this screen object. Clears the NotifyPositionChanged delegate in the removed child

Parameters:

• WidgetOwner - the screen object that the widget was removed from.
• OldChild - the widget that was removed
• ExclusionSet - used to indicate that multiple widgets are being removed in one batch; useful for preventing references between the widgets being removed from being severed. NOTE: If a value is specified, OldChild will ALWAYS be part of the ExclusionSet, since it is being removed.

Other instance functions

SetupDockingLinks

function SetupDockingLinks ()

SetValue

function SetValue (string NewValue)