Cogito, ergo sum

UE3:ConsoleEntry (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> ConsoleEntry

Contents

Package: 
Engine
This class in other games:
UDK

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

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

[edit] Constants

[edit] ConsolePromptText

Value: "(> "


[edit] Properties

[edit] Property group 'ConsoleEntry'

[edit] bRenderCursor

Type: bool

controls whether the underline cursor is rendered

[edit] Internal variables

[edit] ConsolePromptBackground

Type: UIImage


Default value: UIImage'Engine.Default__ConsoleEntry:ConsolePromptBackgroundTemplate'

[edit] ConsolePromptLabel

Type: UILabel

displays the text that is currently being typed

Default value: UILabel'Engine.Default__ConsoleEntry:ConsolePromptTemplate'

[edit] CursorPosition

Type: int

Modifiers: transient

the current position of the cursor in InputBox's string

[edit] InputBox

Type: UIEditBox


Default value: UIEditBox'Engine.Default__ConsoleEntry:InputBoxTemplate'

[edit] LowerConsoleBorder

Type: UIImage


Default value: UIImage'Engine.Default__ConsoleEntry:LowerConsoleBorderTemplate'

[edit] UpperConsoleBorder

Type: UIImage


Default value: UIImage'Engine.Default__ConsoleEntry:UpperConsoleBorderTemplate'

[edit] 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'

[edit] Subobjects

[edit] WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UIObject.WidgetEventComponent

No new values.

[edit] Functions

[edit] Events

[edit] 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

[edit] PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Called after this screen object's children have been initialized

[edit] RemovedChild

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

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.

[edit] Other instance functions

[edit] SetupDockingLinks

function SetupDockingLinks ()


[edit] SetValue

function SetValue (string NewValue)