The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE2:UIConsole (U2)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
U2 Object >> Console >> UIConsole
Package: 
UI
This class in other games:
U2XMP

$Author: Aleiby $ $Date: 11/03/02 9:34p $ $Revision: 20 $ Name: UIConsole.uc Author: Aaron R Leiby Date: 21 September 2000 Description: Notes:

Our Root component will automatically get deleted when we are destroyed.

(This is performed in UUIConsole.cpp)

How to use this class:

Properties[edit]

Property group 'UIConsole'[edit]

bAlt[edit]

Type: bool

Modifiers: public


bCtrl[edit]

Type: bool

Modifiers: public


bHideUI[edit]

Type: bool

Modifiers: public


bShift[edit]

Type: bool

Modifiers: public


Filename[edit]

Type: string

Modifiers: public, config


Default value: "UI"

OffsetX[edit]

Type: float

Modifiers: public, config


OffsetY[edit]

Type: float

Modifiers: public, config


ScaleX[edit]

Type: float

Modifiers: public, config


Default value: 1.0

ScaleY[edit]

Type: float

Modifiers: public, config


Default value: 1.0

Internal variables[edit]

ActionTickListeners[edit]

Type: array<int>

Modifiers: private, const, native, noexport

TArray<ActionEvent*>

Assets[edit]

Type: array<Object>

Assets we are using -- keep a pointer around so they don't get garbage collected.

bRendering[edit]

Type: bool


EventQueue[edit]

Type: array<int>

Modifiers: private, const, native, noexport

TArray<FString>

FrameIndex[edit]

Type: int

useful for caching things on a per-tick basis (like keyframe calculations). updated once per frame regardless of pausing. be wary of wrapping.

Helpers[edit]

Type: array<UIHelper>


HelperTickListeners[edit]

Type: array<int>

Modifiers: private, const, native, noexport

TArray<UUIHelper*>

Incinerator[edit]

Type: array<int>

Modifiers: private, const, native, noexport

TArray<UComponent*>

InputActionListenerTable[edit]

Type: int

Modifiers: private, const, native, noexport

TMap< EInputAction, TArray<NotifyInfo>* >*

KeyEventListeners[edit]

Type: array<int>

Modifiers: private, const, native, noexport

TArray<ActionEvent*>

KeyListeners[edit]

Type: array<int>

Modifiers: private, const, native, noexport

TArray<ActionEvent*>

LastLevelAction[edit]

Type: string


LastURL[edit]

Type: string


LevelComponents[edit]

Type: array<Object.ComponentHandle>

Level specific ui components.

MessageAreas[edit]

Type: array<int>

Modifiers: private, const, native, noexport


Root[edit]

Type: Object.ComponentHandle


TickListeners[edit]

Type: array<int>

Modifiers: private, const, native, noexport

TArray<UComponent*>

Functions[edit]

Static native functions[edit]

AddComponent[edit]

static native function AddComponent (Object.ComponentHandle Component, optional Object.ComponentHandle Container)


AddKeyEventListener[edit]

static native function int AddKeyEventListener (Object Target, string TargetFunc)


AddKeyListener[edit]

static native function int AddKeyListener (Object Target, string TargetFunc)


AddNewComponent[edit]

static native function Object.ComponentHandle AddNewComponent (string Name, optional string Parent)


AddWatch[edit]

static native function AddWatch (name ObjName, name VarName, optional int ArrayIndex)


DestroyComponent[edit]

static native function Object.ComponentHandle DestroyComponent (Object.ComponentHandle Component)


FindLooseComponent[edit]

static native function Object.ComponentHandle FindLooseComponent (string Name, optional Object.ComponentHandle Root)


GetClient[edit]

static native function client GetClient ()


GetComponent[edit]

static native function Object.ComponentHandle GetComponent (string Name, optional Object.ComponentHandle Root)


GetComponentSize[edit]

static native function Object.Dimension GetComponentSize (Object.ComponentHandle Root)


GetConsole[edit]

static native function Console GetConsole ()


GetInstance[edit]

native static function UIConsole GetInstance ()


GetLooseComponents[edit]

static native function GetLooseComponents (string Name, out array<Object.ComponentHandleComponents, optional Object.ComponentHandle Root)


GetPlayerOwner[edit]

static native function PlayerController GetPlayerOwner ()


GetTimeSeconds[edit]

static native function float GetTimeSeconds ()


GetUIConsole[edit]

static native function UIConsole GetUIConsole ()


LoadComponent[edit]

static native exec function Object.ComponentHandle LoadComponent (string Filename, optional string Component)


RegisterRenderListener[edit]

static native function RegisterRenderListener (Object TargetObj, string TargetFunc)


RemoveKeyEventListener[edit]

static native function RemoveKeyEventListener (int MagicKey)


RemoveKeyListener[edit]

static native function RemoveKeyListener (int MagicKey)


SecondsToTime[edit]

static native function string SecondsToTime (float TimeSeconds, optional bool bNoSeconds)


SendEvent[edit]

static native function SendEvent (string EventName, optional Object.ComponentHandle Target)


ThrowKeyEvent[edit]

static native function ThrowKeyEvent (Console.EInputKey Key, Console.EInputAction Action, optional float Delta)


ThrowKeyType[edit]

static native function ThrowKeyType (Console.EInputKey Key)


UnRegisterRenderListener[edit]

static native function UnRegisterRenderListener (Object TargetObj, string TargetFunc)


Other static functions[edit]

ClearProgressMessages[edit]

static function ClearProgressMessages (PlayerController P)


Native functions[edit]

AddTickListener[edit]

public native function AddTickListener (Object A)


DispatchMessage[edit]

public native function DispatchMessage (coerce string Msg)


RemoveTickListener[edit]

public native function RemoveTickListener (Object A)


TimedMessage[edit]

native function TimedMessage (coerce string Msg, optional float Duration, optional Font Font, optional Object.Color Color, optional string Holder, optional string Label, optional bool bClearExisting, optional float WrapX, optional bool bReverseOrder)

Overrides: Console.TimedMessage


Events[edit]

ConnectFailure[edit]

event ConnectFailure (string FailCode, string URL)

Overrides: Console.ConnectFailure


Message[edit]

event Message (coerce string Msg, float MsgLife)

Overrides: Console.Message


NotifyLevelChange[edit]

event NotifyLevelChange ()

Overrides: Console.NotifyLevelChange


Other instance functions[edit]

GetLevelAction[edit]

interface function string GetLevelAction ()