I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE3:UTConsole (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> UIRoot >> Interaction >> Console >> UTConsole
Package: 
UTGame
Within class: 
GameViewportClient
This class in other games:
UT, UT3

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Extended version of console that only allows the quick console to be open if there are no UI scenes open, this is to allow UI scenes to process the TAB key.

Properties[edit]

TextCount[edit]

Type: int


Instance functions[edit]

InputKey[edit]

function bool InputKey (int ControllerId, name Key, Object.EInputEvent Event, float AmountDepressed, bool bGamepad)

Overrides: Console.InputKey

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.

Parameters:

  • ControllerId - the controller that generated this input key event
  • Key - the name of the key which an event occured for (KEY_Up, KEY_Down, etc.)
  • EventType - the type of event which occured (pressed, released, etc.)
  • AmountDepressed - for analog keys, the depression percent.

Returns:

true to consume the key event, false to pass it on.

OutputTextLine[edit]

function OutputTextLine (coerce string Text)

Overrides: Console.OutputTextLine

(Description copied from Console.OutputTextLine)
Prints a single line of text to the console.

Parameters:

  • Text - A line of text to display on the console.

States[edit]

Typing[edit]

This state is used when the typing bar is open.

Typing.InputKey[edit]

function bool InputKey (int ControllerId, name Key, Object.EInputEvent Event, float AmountDepressed, bool bGamepad)

Overrides: Console.Typing.InputKey

(Description copied from Console.Typing.InputKey)
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.

Parameters:

  • ControllerId - the controller that generated this input key event
  • Key - the name of the key which an event occured for (KEY_Up, KEY_Down, etc.)
  • EventType - the type of event which occured (pressed, released, etc.)
  • AmountDepressed - for analog keys, the depression percent.

Returns:

true to consume the key event, false to pass it on.