Engine.Console

Extends

Interaction

Modifiers

within GameViewportClient transient config ( Input ) native ( UserInterface )

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.Interaction
      |   
      +-- Engine.Console

Direct Known Subclasses:

UTConsole

Functions Summary
		AppendInputText (string Text))
		BeginState (Name PreviousStateName)) Open
		BeginState (Name PreviousStateName)) Typing
		ClearOutput ()))
		ConsoleCommand (string Command))
		EndState (Name NextStateName )) Open
		EndState (Name NextStateName )) Typing
		FlushPlayerInput ()))
		Initialized ()))
	bool	InputChar (int ControllerId, string Unicode ))
	bool	InputChar (int ControllerId, string Unicode )) Open
	bool	InputChar (int ControllerId, string Unicode )) Typing
	bool	InputKey (int ControllerId, name Key, EInputEvent Event, float AmountDepressed = 1.f, bool bGamepad = FALSE ))
	bool	InputKey (int ControllerId, name Key, EInputEvent Event, float AmountDepressed = 1.f, bool bGamepad = FALSE )) Open
	bool	InputKey (int ControllerId, name Key, EInputEvent Event, float AmountDepressed = 1.f, bool bGamepad = FALSE )) Typing
	bool	IsUIConsoleOpen ()))
	bool	IsUIMiniConsoleOpen ()))
		OutputText (coerce string Text))
		OutputTextLine (coerce string Text))
		PostRender_Console (Canvas Canvas)
		PostRender_Console (Canvas Canvas)) Open
		PostRender_Console (Canvas Canvas)) Typing
	bool	ProcessControlKey (name Key, EInputEvent Event))
		PurgeCommandFromHistory (string Command))
		SetCursorPos (int Position ))
		SetInputText (string Text ))
		StartTyping (coerce string Text))

MaxHistory Source code

bCaptureKeyInput Source code

Indicates that InputChar events should be captured to prevent them from being passed on to other interactions. Reset when the another keydown event is received.

bCtrl Source code

True while a control key is pressed.

bEnableUI Source code

ConsoleBufferText Source code

ConsoleKey Source code

The key which opens the console.

ConsoleTargetPlayer Source code

The player which the next console command should be executed in the context of. If NULL, execute in the viewport.

DefaultTexture_Black Source code

DefaultTexture_White Source code

HistoryBot Source code

index into the History array for the earliest command that was entered

HistoryCur Source code

the index of the current position in the History array

HistoryTop Source code

index into the History array for the latest command that was entered

History[MaxHistory] Source code

tracks previously entered console commands

LargeConsoleInput Source code

LargeConsoleScene Source code

MaxScrollbackSize Source code

Visible Console stuff

MiniConsoleInput Source code

MiniConsoleScene Source code

SBHead Source code

Where in the scrollback buffer are we

SBPos Source code

Where in the scrollback buffer are we

Scrollback Source code

Holds the scrollback buffer

TypedStr Source code

The command the user is currently typing.

TypedStrPos Source code

TypeKey Source code

The key which opens the typing bar.

AppendInputText Source code

appends the specified text to the string of typed text

BeginState Open Source code

BeginState Typing Source code

ClearOutput Source code

Clears the console output buffer.

ConsoleCommand Source code

Executes a console command.
@param Command - The command to execute.

EndState Open Source code

EndState Typing Source code

FlushPlayerInput Source code

Clears out all pressed keys from the player's input object.

Initialized Source code

Called when the Console is added to the GameViewportClient's Interactions array.

InputChar Source code

Process a character input event (typing) routed through unrealscript from another object. This method is assigned as the value for the OnRecievedNativeInputKey delegate so that native input events are routed to this unrealscript function.
@param ControllerId the controller that generated this character input event
@param Unicode the character that was typed
@return True to consume the character, false to pass it on.

InputChar Open Source code

InputChar Typing Source code

Process a character input event (typing) routed through unrealscript from another object. This method is assigned as the value for the OnRecievedNativeInputKey delegate so that native input events are routed to this unrealscript function.
@param ControllerId the controller that generated this character input event
@param Unicode the character that was typed
@return True to consume the character, false to pass it on.

InputKey Source code

Process an input key event routed through unrealscript from another object. This method is assigned as the value for the OnRecievedNativeInputKey delegate so that native input events are routed to this unrealscript function.
@param ControllerId the controller that generated this input key event
@param Key the name of the key which an event occured for (KEY_Up, KEY_Down, etc.)
@param EventType the type of event which occured (pressed, released, etc.)
@param AmountDepressed for analog keys, the depression percent.
@return true to consume the key event, false to pass it on.

InputKey Open Source code

Process an input key event routed through unrealscript from another object. This method is assigned as the value for the OnRecievedNativeInputKey delegate so that native input events are routed to this unrealscript function.
@param ControllerId the controller that generated this input key event
@param Key the name of the key which an event occured for (KEY_Up, KEY_Down, etc.)
@param EventType the type of event which occured (pressed, released, etc.)
@param AmountDepressed for analog keys, the depression percent.
@return true to consume the key event, false to pass it on.

InputKey Typing Source code

Process an input key event routed through unrealscript from another object. This method is assigned as the value for the OnRecievedNativeInputKey delegate so that native input events are routed to this unrealscript function.
@param ControllerId the controller that generated this input key event
@param Key the name of the key which an event occured for (KEY_Up, KEY_Down, etc.)
@param EventType the type of event which occured (pressed, released, etc.)
@param AmountDepressed for analog keys, the depression percent.
@return true to consume the key event, false to pass it on.

IsUIConsoleOpen Source code

IsUIMiniConsoleOpen Source code

OutputText Source code

Prints a (potentially multi-line) string of text to the console. The text is split into separate lines and passed to OutputTextLine.
@param Text - Text to display on the console.

OutputTextLine Source code

Prints a single line of text to the console.
@param Text - A line of text to display on the console.

PostRender_Console Source code

PostRender_Console Open Source code

PostRender_Console Typing Source code

ProcessControlKey Source code

looks for Control key presses and the copy/paste combination that apply to both the console bar and the full open console

PurgeCommandFromHistory Source code

Searches console command history and removes any entries matching the specified command.
@param Command - The command to search for and purge from the history.

SetCursorPos Source code

SetInputText Source code

StartTyping Source code

Opens the typing bar with text already entered.
@param Text - The text to enter in the typing bar.

defaultproperties
{
   DefaultTexture_Black=Texture2D'EngineResources.Black'
   DefaultTexture_White=Texture2D'EngineResources.White'
   ConsoleKey="F10"
   TypeKey="Tab"
   MaxScrollbackSize=1024
   HistoryBot=-1
   __OnReceivedNativeInputKey__Delegate=Default__Console.InputKey
   __OnReceivedNativeInputChar__Delegate=Default__Console.InputChar
   Name="Default__Console"
   ObjectArchetype=Interaction'Engine.Default__Interaction'
}