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

UE2:Console (UT2004)

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

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

Properties

Property group 'Console'

bHoldingBack

Type: bool

Modifiers: transient


bHoldingStart

Type: bool

Modifiers: transient


bRunningDemo

Type: bool

Modifiers: transient


DemoLevels

Type: string

Array size: 64

Modifiers: globalconfig


TimeBeforeReboot

Type: float

Modifiers: globalconfig

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

Default value: 5.0

TimeHoldingReboot

Type: float

Modifiers: transient

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

TimeIdle

Type: float

Modifiers: transient

Time since last input.

TimePerDemo

Type: float

Modifiers: globalconfig

Time spent running in attract mode.

Default value: 300.0

TimePerSoak

Type: float

Modifiers: globalconfig

TimePerDemo while soaking.

TimePerTitle

Type: float

Modifiers: globalconfig

Time spent at title screen.

TimeTooIdle

Type: float

Modifiers: globalconfig

Time allowed idle players in locked interactive demo.

Default value: 60.0

Internal variables

bIgnoreKeys

Type: bool

Ignore Key presses until a new KeyDown is received

bTyping

Type: bool

Turn when someone is typing on the console

BufferedConsoleCommands

Type: array<string>

If this is blank, perform the command at Tick

ConsoleHotKey

Type: byte

Modifiers: config

The key used to bring the console up.

History

Type: string

Array size: 16

Holds the current command, and the history

HistoryBot

Type: int


Default value: -1

HistoryCur

Type: int


HistoryTop

Type: int


TypedStr

Type: string


TypedStrPos

Type: int

Current position in TypedStr

Default values

Property Value
bRequiresTick True

Functions

Exec functions

ConsoleClose

exec function ConsoleClose ()


ConsoleOpen

exec function ConsoleOpen ()


ConsoleToggle

exec function ConsoleToggle ()


StartRollingDemo

exec function StartRollingDemo ()


StopRollingDemo

exec function StopRollingDemo ()


Talk

exec function Talk ()


TeamTalk

exec function TeamTalk ()


Type

exec function Type ()


Events

ConnectFailure

event ConnectFailure (string FailCode, string URL)


Initialized

event Initialized ()

Overrides: Interaction.Initialized


KeyEvent

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

Overrides: Interaction.KeyEvent


Message

event Message (coerce string Msg, float MsgLife)

Overrides: Interaction.Message


NativeConsoleOpen

event NativeConsoleOpen ()


NotifyLevelChange

event NotifyLevelChange ()

Overrides: Interaction.NotifyLevelChange


Tick

simulated event Tick (float Delta)

Overrides: Interaction.Tick


ViewportInitialized

event ViewportInitialized ()


Other instance functions

Chat

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


DelayedConsoleCommand

function DelayedConsoleCommand (string command)


SetInitialMusic

function string SetInitialMusic (string NewSong)


SetMusic

function SetMusic (string NewSong)


TypingClose

function TypingClose ()


TypingOpen

function TypingOpen ()


UnPressButtons

function UnPressButtons ()


States

Typing

Typing.BeginState

event BeginState ()

Overrides: Object.BeginState (global)


Typing.EndState

event EndState ()

Overrides: Object.EndState (global)


Typing.KeyEvent

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

Overrides: KeyEvent (global)


Typing.KeyType

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

Overrides: Interaction.KeyType (global)


Typing.Type

exec function Type ()

Overrides: Type (global)