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

Contents

Package: 
Engine
Direct subclass:
ExtendedConsole
This class in other games:
RTNP, U1, U2, U2XMP, UDK, UE2Runtime, UT, UT2003, UT3

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

[edit] Properties

[edit] Property group 'Console'

[edit] bHoldingBack

Type: bool

Modifiers: transient


[edit] bHoldingStart

Type: bool

Modifiers: transient


[edit] bRunningDemo

Type: bool

Modifiers: transient


[edit] DemoLevels

Type: string

Array size: 64

Modifiers: globalconfig


[edit] TimeBeforeReboot

Type: float

Modifiers: globalconfig

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

Default value: 5.0

[edit] TimeHoldingReboot

Type: float

Modifiers: transient

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

[edit] TimeIdle

Type: float

Modifiers: transient

Time since last input.

[edit] TimePerDemo

Type: float

Modifiers: globalconfig

Time spent running in attract mode.

Default value: 300.0

[edit] TimePerSoak

Type: float

Modifiers: globalconfig

TimePerDemo while soaking.

[edit] TimePerTitle

Type: float

Modifiers: globalconfig

Time spent at title screen.

[edit] TimeTooIdle

Type: float

Modifiers: globalconfig

Time allowed idle players in locked interactive demo.

Default value: 60.0

[edit] Internal variables

[edit] bIgnoreKeys

Type: bool

Ignore Key presses until a new KeyDown is received

[edit] bTyping

Type: bool

Turn when someone is typing on the console

[edit] BufferedConsoleCommands

Type: array<string>

If this is blank, perform the command at Tick

[edit] ConsoleHotKey

Type: byte

Modifiers: config

The key used to bring the console up.

[edit] History

Type: string

Array size: 16

Holds the current command, and the history

[edit] HistoryBot

Type: int


Default value: -1

[edit] HistoryCur

Type: int


[edit] HistoryTop

Type: int


[edit] TypedStr

Type: string


[edit] TypedStrPos

Type: int

Current position in TypedStr

[edit] Default values

Property Value
bRequiresTick True

[edit] Functions

[edit] Exec functions

[edit] ConsoleClose

exec function ConsoleClose ()


[edit] ConsoleOpen

exec function ConsoleOpen ()


[edit] ConsoleToggle

exec function ConsoleToggle ()


[edit] StartRollingDemo

exec function StartRollingDemo ()


[edit] StopRollingDemo

exec function StopRollingDemo ()


[edit] Talk

exec function Talk ()


[edit] TeamTalk

exec function TeamTalk ()


[edit] Type

exec function Type ()


[edit] Events

[edit] ConnectFailure

event ConnectFailure (string FailCode, string URL)


[edit] Initialized

event Initialized ()

Overrides: Interaction.Initialized


[edit] KeyEvent

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

Overrides: Interaction.KeyEvent


[edit] Message

event Message (coerce string Msg, float MsgLife)

Overrides: Interaction.Message


[edit] NativeConsoleOpen

event NativeConsoleOpen ()


[edit] NotifyLevelChange

event NotifyLevelChange ()

Overrides: Interaction.NotifyLevelChange


[edit] Tick

simulated event Tick (float Delta)

Overrides: Interaction.Tick


[edit] ViewportInitialized

event ViewportInitialized ()


[edit] Other instance functions

[edit] Chat

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


[edit] DelayedConsoleCommand

function DelayedConsoleCommand (string command)


[edit] SetInitialMusic

function string SetInitialMusic (string NewSong)


[edit] SetMusic

function SetMusic (string NewSong)


[edit] TypingClose

function TypingClose ()


[edit] TypingOpen

function TypingOpen ()


[edit] UnPressButtons

function UnPressButtons ()


[edit] States

[edit] Typing

[edit] Typing.BeginState

event BeginState ()

Overrides: Object.BeginState (global)


[edit] Typing.EndState

event EndState ()

Overrides: Object.EndState (global)


[edit] Typing.KeyEvent

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

Overrides: KeyEvent (global)


[edit] Typing.KeyType

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

Overrides: Interaction.KeyType (global)


[edit] Typing.Type

exec function Type ()

Overrides: Type (global)


Personal tools