My program doesn't have bugs. It just develops random features.

UE3:UTConsole (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 10:11, 17 May 2008 by Wormbo (Talk | contribs) (Auto-generated page)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UT3 Object >> UIRoot >> Interaction >> Console >> UTConsole
Package: 
UTGame
Within class: 
GameViewportClient
This class in other games:
UT, UDK

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

TextCount

Type: int


Instance functions

InputKey

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

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

Typing

This state is used when the typing bar is open.

Typing.InputKey

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.