I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX
UE3:Console (UT3)
Object >> UIRoot >> Interaction >> Console |
Contents
- 1 Constants
- 2 Properties
- 2.1 bCaptureKeyInput
- 2.2 bCtrl
- 2.3 bEnableUI
- 2.4 ConsoleBufferText
- 2.5 ConsoleKey
- 2.6 ConsoleTargetPlayer
- 2.7 DefaultTexture_Black
- 2.8 DefaultTexture_White
- 2.9 History
- 2.10 HistoryBot
- 2.11 HistoryCur
- 2.12 HistoryTop
- 2.13 LargeConsoleInput
- 2.14 LargeConsoleScene
- 2.15 MaxScrollbackSize
- 2.16 MiniConsoleInput
- 2.17 MiniConsoleScene
- 2.18 SBHead
- 2.19 SBPos
- 2.20 Scrollback
- 2.21 TypedStr
- 2.22 TypedStrPos
- 2.23 TypeKey
- 2.24 Default values
- 3 Functions
- 3.1 Events
- 3.2 Other instance functions
- 3.2.1 AppendInputText
- 3.2.2 ClearOutput
- 3.2.3 ConsoleCommand
- 3.2.4 FlushPlayerInput
- 3.2.5 Initialized
- 3.2.6 InputChar
- 3.2.7 InputKey
- 3.2.8 IsUIConsoleOpen
- 3.2.9 IsUIMiniConsoleOpen
- 3.2.10 OutputTextLine
- 3.2.11 PostRender_Console
- 3.2.12 ProcessControlKey
- 3.2.13 PurgeCommandFromHistory
- 3.2.14 SetCursorPos
- 3.2.15 SetInputText
- 3.2.16 StartTyping
- 4 States
- Package:
- Engine
- Within class:
- GameViewportClient
- Direct subclass:
- UTConsole
- This class in other games:
- RTNP, U1, UT, UE2Runtime, U2XMP, U2, UT2003, UT2004, UDK
This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Console - A quick little command line console that accepts most commands. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
Constants
MaxHistory
Value: 16
- of command history to remember.
Properties
bCaptureKeyInput
Type: bool
Modifiers: transient
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
Type: bool
True while a control key is pressed.
bEnableUI
Type: bool
Modifiers: config
ConsoleBufferText
Type: UILabel
ConsoleKey
Type: name
Modifiers: globalconfig
The key which opens the console.
Default value: 'F10'
ConsoleTargetPlayer
Type: LocalPlayer
The player which the next console command should be executed in the context of. If NULL, execute in the viewport.
DefaultTexture_Black
Type: Texture2D
Default value: Texture2D'EngineResources.Black'
DefaultTexture_White
Type: Texture2D
Default value: Texture2D'EngineResources.White'
History
Type: string
Array size: 16 (MaxHistory
)
Modifiers: config
tracks previously entered console commands
HistoryBot
Type: int
Modifiers: config
index into the History array for the earliest command that was entered
Default value: -1
HistoryCur
Type: int
Modifiers: config
the index of the current position in the History array
HistoryTop
Type: int
Modifiers: config
index into the History array for the latest command that was entered
LargeConsoleInput
Type: ConsoleEntry
LargeConsoleScene
Type: UIScene
MaxScrollbackSize
Type: int
Modifiers: globalconfig
Visible Console stuff
Default value: 1024
MiniConsoleInput
Type: ConsoleEntry
MiniConsoleScene
Type: UIScene
SBHead
Type: int
Where in the scrollback buffer are we
SBPos
Type: int
Where in the scrollback buffer are we
Scrollback
Holds the scrollback buffer
TypedStr
Type: string
The command the user is currently typing.
TypedStrPos
Type: int
Current position in TypedStr
TypeKey
Type: name
Modifiers: globalconfig
The key which opens the typing bar.
Default value: 'Tab'
Default values
Property | Value |
---|---|
OnReceivedNativeInputChar | InputChar |
OnReceivedNativeInputKey | InputKey |
Functions
Events
OutputText
Prints a (potentially multi-line) string of text to the console. The text is split into separate lines and passed to OutputTextLine.
Parameters:
- Text - Text to display on the console.
Other instance functions
AppendInputText
appends the specified text to the string of typed text
ClearOutput
Clears the console output buffer.
ConsoleCommand
Executes a console command.
Parameters:
- Command - The command to execute.
FlushPlayerInput
Clears out all pressed keys from the player's input object.
Initialized
Overrides: Interaction.Initialized
Called when the Console is added to the GameViewportClient's Interactions array.
InputChar
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.
Parameters:
- ControllerId - the controller that generated this character input event
- Unicode - the character that was typed
Returns:
- True to consume the character, false to pass it on.
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.
IsUIConsoleOpen
IsUIMiniConsoleOpen
OutputTextLine
Prints a single line of text to the console.
Parameters:
- Text - A line of text to display on the console.
PostRender_Console
ProcessControlKey
looks for Control key presses and the copy/paste combination that apply to both the console bar and the full open console
PurgeCommandFromHistory
Searches console command history and removes any entries matching the specified command.
Parameters:
- Command - The command to search for and purge from the history.
SetCursorPos
SetInputText
StartTyping
Opens the typing bar with text already entered.
Parameters:
- Text - The text to enter in the typing bar.
States
Open
Open.BeginState
Overrides: Object.BeginState (global)
Called immediately when entering a state, while within the GotoState() call that caused the state change (before any state code is executed).
Open.EndState
Overrides: Object.EndState (global)
Called immediately before going out of the current state, while within the GotoState() call that caused the state change, and before BeginState() is called within the new state.
Open.PostRender_Console
Overrides: PostRender_Console (global)
Open.InputChar
Overrides: InputChar (global)
(Description copied from Console.InputChar)
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.
Parameters:
- ControllerId - the controller that generated this character input event
- Unicode - the character that was typed
Returns:
- True to consume the character, false to pass it on.
Open.InputKey
Overrides: InputKey (global)
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.
Typing
This state is used when the typing bar is open.
Typing.BeginState
Overrides: Object.BeginState (global)
Called immediately when entering a state, while within the GotoState() call that caused the state change (before any state code is executed).
Typing.EndState
Overrides: Object.EndState (global)
Called immediately before going out of the current state, while within the GotoState() call that caused the state change, and before BeginState() is called within the new state.
Typing.PostRender_Console
Overrides: PostRender_Console (global)
Typing.InputChar
Overrides: InputChar (global)
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.
Parameters:
- ControllerId - the controller that generated this character input event
- Unicode - the character that was typed
Returns:
- True to consume the character, false to pass it on.
Typing.InputKey
Overrides: InputKey (global)
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.