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

UE1:Console (UT)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT Object >> Console

Contents

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

Console: A player console, associated with a viewport. This is a built-in Unreal class and it shouldn't be modified.

Constants

MaxBorder

Value: 6


MaxLines

Value: 64


MaxHistory

Value: 16


TextMsgSize

Value: 128


Properties

AvgText

Type: string

Modifiers: localized


Default value: "Avg"

bNoDrawWorld

Type: bool


bNoStuff

Type: bool


Border

Type: Texture


Default value: Texture'Engine.Border'

BorderLines

Type: int


BorderPixels

Type: int


BorderSize

Type: int


bRestartTimeDemo

Type: bool


bSaveTimeDemoToFile

Type: bool


bStartTimeDemo

Type: bool


bTimeDemo

Type: bool


bTyping

Type: bool


ConBackground

Type: Texture


Default value: Texture'Engine.ConsoleBack'

ConnectingMessage

Type: string

Modifiers: localized


Default value: "CONNECTING"

ConsoleDest

Type: float


ConsoleLines

Type: int


ConsolePos

Type: float


ExtraTime

Type: float


fpsText

Type: string

Modifiers: localized


Default value: "fps"

FrameCount

Type: int


FrameRateText

Type: string

Modifiers: localized


Default value: "Frame Rate"

FramesText

Type: string

Modifiers: localized


Default value: "frames rendered in"

FrameX

Type: float


FrameY

Type: float


History

Type: string

Array size: 16


HistoryBot

Type: int


HistoryCur

Type: int


HistoryTop

Type: int


LastFrameTime

Type: float


LastSecFPS

Type: float


LastSecondFrameCount

Type: int


LastSecondStartTime

Type: float


LastSecText

Type: string

Modifiers: localized


Default value: "Last Sec"

LoadingMessage

Type: string

Modifiers: localized


Default value: "LOADING"

MaxFPS

Type: float


MaxText

Type: string

Modifiers: localized


Default value: "Max"

MinFPS

Type: float


MinText

Type: string

Modifiers: localized


Default value: "Min"

MsgPlayer

Type: PlayerReplicationInfo

Array size: 64


MsgText

Type: string

Array size: 64


MsgTick

Type: float

Array size: 64


MsgTickTime

Type: float


MsgTime

Type: float


MsgType

Type: name

Array size: 64


NumLines

Type: int


PausedMessage

Type: string

Modifiers: localized


Default value: "PAUSED"

PrecachingMessage

Type: string

Modifiers: localized


Default value: "PRECACHING"

SavingMessage

Type: string

Modifiers: localized


Default value: "SAVING"

Scrollback

Type: int


SecondsText

Type: string

Modifiers: localized


Default value: "seconds."

StartTime

Type: float


TextLines

Type: int


TimeDemoFont

Type: Font


Default value: Font'Engine.SmallFont'

TopLine

Type: int


TypedStr

Type: string


Viewport

Type: Viewport


vtblOut

Type: int

Modifiers: private, const


Enums

See Console enums.

Functions

Exec functions

Talk

exec function Talk ()


TeamTalk

exec function TeamTalk ()


TimeDemo

exec function TimeDemo (bool bEnabled, optional bool bSaveToFile)


Type

exec function Type ()


ViewDown

exec function ViewDown ()


ViewUp

exec function ViewUp ()


Native functions

ConsoleCommand

native function bool ConsoleCommand (coerce string S)


SaveTimeDemo

native function SaveTimeDemo (string S)


Events

AddString

event AddString (coerce string Msg)


ConnectFailure

event ConnectFailure (string FailCode, string URL)


KeyEvent

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


KeyType

event bool KeyType (EInputKey Key)


Message

event Message (PlayerReplicationInfo PRI, coerce string Msg, name N)


NotifyLevelChange

event NotifyLevelChange ()


PostRender

event PostRender (Canvas C)


PreRender

event PreRender (Canvas C)


Tick

event Tick (float Delta)


VideoChange

event VideoChange ()


Other instance functions

ClearMessages

function ClearMessages ()


DrawConsoleView

simulated function DrawConsoleView (Canvas C)


DrawLevelAction

function DrawLevelAction (Canvas C)


DrawSingleView

simulated function DrawSingleView (Canvas C)


FormatFloat

final function string FormatFloat (float f)


GetMsgPlayer

function PlayerReplicationInfo GetMsgPlayer (int Index)


GetMsgText

function string GetMsgText (int Index)


GetMsgTick

function float GetMsgTick (int Index)


GetMsgType

function name GetMsgType (int Index)


PrintActionMessage

function PrintActionMessage (Canvas C, string BigMessage)


PrintTimeDemoResult

function PrintTimeDemoResult ()


SetMsgPlayer

function SetMsgPlayer (int Index, PlayerReplicationInfo NewMsgPlayer)


SetMsgText

function SetMsgText (int Index, string NewMsgText)


SetMsgTick

function SetMsgTick (int Index, int NewMsgTick)


SetMsgType

function SetMsgType (int Index, name NewMsgType)


StartTimeDemo

function StartTimeDemo ()


StopTimeDemo

function StopTimeDemo ()


TimeDemoCalc

function TimeDemoCalc ()


TimeDemoRender

function TimeDemoRender (Canvas C)


States

EndMenuing

EndMenuing.KeyEvent

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

Overrides: KeyEvent (global)


KeyMenuing

KeyMenuing.BeginState

event BeginState ()

Overrides: Object.BeginState (global)


KeyMenuing.EndState

event EndState ()

Overrides: Object.EndState (global)


KeyMenuing.KeyEvent

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

Overrides: KeyEvent (global)


KeyMenuing.KeyType

event bool KeyType (EInputKey Key)

Overrides: KeyType (global)


Menuing

Menuing.BeginState

event BeginState ()

Overrides: Object.BeginState (global)


Menuing.EndState

event EndState ()

Overrides: Object.EndState (global)


Menuing.KeyEvent

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

Overrides: KeyEvent (global)


MenuTyping

MenuTyping.BeginState

event BeginState ()

Overrides: Object.BeginState (global)


MenuTyping.EndState

event EndState ()

Overrides: Object.EndState (global)


MenuTyping.KeyEvent

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

Overrides: KeyEvent (global)


MenuTyping.KeyType

event bool KeyType (EInputKey Key)

Overrides: KeyType (global)


Typing

Typing.BeginState

event BeginState ()

Overrides: Object.BeginState (global)


Typing.EndState

event EndState ()

Overrides: Object.EndState (global)


Typing.KeyEvent

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

Overrides: KeyEvent (global)


Typing.KeyType

event bool KeyType (EInputKey Key)

Overrides: KeyType (global)


Typing.Type

exec function Type ()

Overrides: Type (global)