UE2:UIConsole (U2XMP)

Object >> Console >> UIConsole

Package: 

UI

This class in other games:

U2

$Author: Aleiby $ $Date: 2/25/03 10:40a $ $Revision: 21 $ 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

Property group 'UIConsole'

bAlt

Type: bool

Modifiers: public

bCtrl

Type: bool

Modifiers: public

bHideUI

Type: bool

Modifiers: public

bShift

Type: bool

Modifiers: public

Filename

Type: string

Modifiers: public, config

Default value: "UI"

OffsetX

Type: float

Modifiers: public, config

OffsetY

Type: float

Modifiers: public, config

ScaleX

Type: float

Modifiers: public, config

Default value: 1.0

ScaleY

Type: float

Modifiers: public, config

Default value: 1.0

Internal variables

ActionTickListeners

Type: array<int>

Modifiers: private, const, native, noexport

TArray<ActionEvent*>

Assets

Type: array<Object>

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

bEchoToHUD

Type: bool

bRendering

Type: bool

FrameIndex

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

Type: array<UIHelper>

HelperTickListeners

Type: array<int>

Modifiers: private, const, native, noexport

TArray<UUIHelper*>

Incinerator

Type: array<int>

Modifiers: private, const, native, noexport

TArray<UComponent*>

InputActionListenerTable

Type: int

Modifiers: private, const, native, noexport

TMap< EInputAction, TArray<NotifyInfo>* >*

KeyEventListeners

Type: array<int>

Modifiers: private, const, native, noexport

TArray<ActionEvent*>

KeyListeners

Type: array<int>

Modifiers: private, const, native, noexport

TArray<ActionEvent*>

LastLevelAction

Type: string

MessageAreas

Type: array<int>

Modifiers: private, const, native, noexport

Root

Type: Object.ComponentHandle

TickListeners

Type: array<int>

Modifiers: private, const, native, noexport

TArray<UComponent*>

Functions

Static native functions

AddComponent

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

AddKeyEventListener

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

AddKeyListener

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

AddWatch

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

DestroyComponent

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

FindLooseComponent

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

GetClient

static native function client GetClient ()

GetComponent

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

GetComponentSize

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

GetConsole

static native function Console GetConsole ()

GetInstance

native static function UIConsole GetInstance ()

GetLooseComponents

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

GetPlayerOwner

static native function PlayerController GetPlayerOwner ()

GetTimeSeconds

static native function float GetTimeSeconds ()

GetUIConsole

static native function UIConsole GetUIConsole ()

LoadComponent

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

RegisterRenderListener

static native function RegisterRenderListener (Object TargetObj, string TargetFunc)

RemoveKeyEventListener

static native function RemoveKeyEventListener (int MagicKey)

RemoveKeyListener

static native function RemoveKeyListener (int MagicKey)

SendEvent

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

SetOwner

static native function SetOwner (Object.ComponentHandle Component, Object Owner)

UnRegisterRenderListener

static native function UnRegisterRenderListener (Object TargetObj, string TargetFunc)

Other static functions

BroadcastStatusMessage

static function BroadcastStatusMessage (Actor ContextActor, coerce string Msg, optional float Time, optional Font Font, optional Object.Color Color, optional Sound Sound, optional float Volume, optional float Pitch, optional string Holder, optional bool bClearExisting, optional float WrapX, optional bool bReverseOrder)

ClearProgressMessages

static function ClearProgressMessages (PlayerController P)

ShowStatusMessage

static function ShowStatusMessage (PlayerController P, coerce string Msg, optional float Time, optional Font Font, optional Object.Color Color, optional Sound Sound, optional float Volume, optional float Pitch, optional string Holder, optional bool bClearExisting, optional float WrapX, optional bool bReverseOrder)

Exec functions

ToggleEchoToHUD

exec function ToggleEchoToHUD ()

Native functions

AddTickListener

public native function AddTickListener (Object A)

DispatchMessage

public native function DispatchMessage (coerce string Msg)

RemoveTickListener

public native function RemoveTickListener (Object A)

TimedMessage

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

Overrides: Console.TimedMessage

Events

Message

event Message (coerce string Msg, float MsgLife)

Overrides: Console.Message

Other instance functions

GetLevelAction

function string GetLevelAction ()