Console¶

Class in Engine · Engine.Console · transient, config, native

Object › UIRoot › Interaction › Console

Using it from Lua

h7.find_all("Console")            -- live instances
h7.find_class("Engine.Console")   -- the class
h7.hook("Engine.Console.AppendInputText", fn)

Constants¶

Name	Value
`MaxHistory`	`16`

Structs¶

AutoCompleteCommand

Field	Type
`Command`	`string`
`Desc`	`string`

AutoCompleteNode

Field	Type
`IndexChar`	`int`
`array`	`init`
`array`	`init`

Properties¶

Name	Type	Notes
`AutoCompleteIndex`	`int`	transient
`AutoCompleteIndices`	`array`	transient
`AutoCompleteList`	`array<AutoCompleteCommand>`	transient
`AutoCompleteTree`	`AutoCompleteNode`	transient, native
`bAutoCompleteLocked`	`bool`	transient
`bCaptureKeyInput`	`bool`	transient
`bCtrl`	`bool`
`bEnableUI`	`bool`	config
`bIsRuntimeAutoCompleteUpToDate`	`bool`	transient
`bNavigatingHistory`	`bool`	transient
`bRequireCtrlToNavigateAutoComplete`	`bool`	config
`ConsoleKey`	`name`	globalconfig
`ConsoleTargetPlayer`	`LocalPlayer`
`DefaultTexture_Black`	`Texture2D`
`DefaultTexture_White`	`Texture2D`
`History`	`string[MaxHistory]`	config
`HistoryBot`	`int`	config
`HistoryCur`	`int`	config
`HistoryTop`	`int`	config
`ManualAutoCompleteList`	`array<AutoCompleteCommand>`	config
`MaxScrollbackSize`	`int`	globalconfig
`SBHead`	`int`
`SBPos`	`int`
`Scrollback`	`array`
`TypedStr`	`string`
`TypedStrPos`	`int`
`TypeKey`	`name`	globalconfig

Functions¶

Name	Declaration
`AppendInputText`	`function AppendInputText(string Text)`
`BuildRuntimeAutoCompleteList`	`final native function BuildRuntimeAutoCompleteList(optional bool bForce)`
`ClearOutput`	`function ClearOutput()`
`ConsoleCommand`	`function ConsoleCommand(string Command)`
`FlushPlayerInput`	`function FlushPlayerInput()`
`Initialized`	`function Initialized()`
`InputChar`	`function bool InputChar(int ControllerId, string Unicode)`
`InputKey`	`function bool InputKey(int ControllerId, name Key, EInputEvent Event, float AmountDepressed = 1.f, bool bGamepad = FALSE)`
`OutputText`	`event OutputText(coerce string Text)`
`OutputTextLine`	`function OutputTextLine(coerce string Text)`
`PostRender_Console`	`function PostRender_Console(Canvas Canvas)`
`ProcessControlKey`	`function bool ProcessControlKey(name Key, EInputEvent Event)`
`PurgeCommandFromHistory`	`function PurgeCommandFromHistory(string Command)`
`SetCursorPos`	`function SetCursorPos(int Position)`
`SetInputText`	`function SetInputText(string Text)`
`StartTyping`	`function StartTyping(coerce string Text)`
`UpdateCompleteIndices`	`native function UpdateCompleteIndices()`

States¶

State code replaces the class's functions while the object is in that state. Hook a state's version as Engine.Console.<State>.<Function>.

State	Functions
Open	`BeginState`, `InputChar`, `InputKey`, `PostRender_Console`
Typing	`BeginState`, `EndState`, `InputChar`, `InputKey`, `PostRender_Console`

Default values¶

OnReceivedNativeInputKey=InputKey
OnReceivedNativeInputChar=InputChar
DefaultTexture_Black=Texture2D'EngineResources.Black'
DefaultTexture_White=Texture2D'EngineResources.WhiteSquareTexture'

Inherited¶

From	Members
Interaction	0 properties, 11 functions
UIRoot	1 properties, 8 functions
Object	13 properties, 308 functions