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

UE2:Console (UT2003)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2003 Object >> Interactions >> Interaction >> Console
Package: 
Engine
Direct subclass:
ExtendedConsole
This class in other games:
RTNP, U1, UT, UE2Runtime, U2XMP, U2, UT2004, UT3, UDK

Console: handles command input and manages menus. Copyright 2001 Digital Extremes - All Rights Reserved. Confidential.

Properties[edit]

Property group 'Console'[edit]

bHoldingBack[edit]

Type: bool

Modifiers: transient


bHoldingStart[edit]

Type: bool

Modifiers: transient


bRunningDemo[edit]

Type: bool

Modifiers: transient


DemoLevels[edit]

Type: string

Array size: 64

Modifiers: globalconfig


TimeBeforeReboot[edit]

Type: float

Modifiers: globalconfig

If start+back are held for this long it'll reboot.

Default value: 5.0

TimeHoldingReboot[edit]

Type: float

Modifiers: transient

If start+back are held for this long it'll reboot.

TimeIdle[edit]

Type: float

Modifiers: transient

Time since last input.

TimePerDemo[edit]

Type: float

Modifiers: globalconfig

Time spent running in attract mode.

Default value: 300.0

TimePerSoak[edit]

Type: float

Modifiers: globalconfig

TimePerDemo while soaking.

TimePerTitle[edit]

Type: float

Modifiers: globalconfig

Time spent at title screen.

TimeTooIdle[edit]

Type: float

Modifiers: globalconfig

Time allowed idle players in locked interactive demo.

Default value: 60.0

Internal variables[edit]

bIgnoreKeys[edit]

Type: bool

Ignore Key presses until a new KeyDown is received

bTyping[edit]

Type: bool

Turn when someone is typing on the console

BufferedConsoleCommands[edit]

Type: array<string>

If this is blank, perform the command at Tick

ConsoleHotKey[edit]

Type: byte

Modifiers: config

The key used to bring the console up.

History[edit]

Type: string

Array size: 16

Holds the current command, and the history

HistoryBot[edit]

Type: int


Default value: -1

HistoryCur[edit]

Type: int


HistoryTop[edit]

Type: int


TypedStr[edit]

Type: string


Default values[edit]

Property Value
bRequiresTick True

Functions[edit]

Exec functions[edit]

ConsoleClose[edit]

exec function ConsoleClose ()


ConsoleOpen[edit]

exec function ConsoleOpen ()


ConsoleToggle[edit]

exec function ConsoleToggle ()


StartRollingDemo[edit]

exec function StartRollingDemo ()


StopRollingDemo[edit]

exec function StopRollingDemo ()


Talk[edit]

exec function Talk ()


TeamTalk[edit]

exec function TeamTalk ()


Type[edit]

exec function Type ()


Events[edit]

ConnectFailure[edit]

event ConnectFailure (string FailCode, string URL)


Initialized[edit]

event Initialized ()

Overrides: Interaction.Initialized


KeyEvent[edit]

event bool KeyEvent (Interactions.EInputKey Key, Interactions.EInputAction Action, float Delta)

Overrides: Interaction.KeyEvent


Message[edit]

event Message (coerce string Msg, float MsgLife)

Overrides: Interaction.Message


NativeConsoleOpen[edit]

event NativeConsoleOpen ()


NotifyLevelChange[edit]

event NotifyLevelChange ()

Overrides: Interaction.NotifyLevelChange


NotifyMusicChange[edit]

event NotifyMusicChange ()

Overrides: Interaction.NotifyMusicChange


Tick[edit]

simulated event Tick (float Delta)

Overrides: Interaction.Tick


ViewportInitialized[edit]

event ViewportInitialized ()


Other instance functions[edit]

Chat[edit]

function Chat (coerce string Msg, float MsgLife, PlayerReplicationInfo PRI)


DelayedConsoleCommand[edit]

function DelayedConsoleCommand (string command)


SetInitialMusic[edit]

function string SetInitialMusic (string NewSong)


SetMusic[edit]

function SetMusic (string NewSong)


TypingClose[edit]

function TypingClose ()


TypingOpen[edit]

function TypingOpen ()


States[edit]

Typing[edit]

Typing.BeginState[edit]

event BeginState ()

Overrides: Object.BeginState (global)


Typing.EndState[edit]

event EndState ()

Overrides: Object.EndState (global)


Typing.KeyEvent[edit]

event bool KeyEvent (Interactions.EInputKey Key, Interactions.EInputAction Action, float Delta)

Overrides: KeyEvent (global)


Typing.KeyType[edit]

function bool KeyType (Interactions.EInputKey Key, optional string Unicode)

Overrides: Interaction.KeyType (global)


Typing.Type[edit]

exec function Type ()

Overrides: Type (global)