I'm a doctor, not a mechanic

Difference between revisions of "UE3:Console (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
m (1 revision: class descriptions for UDK January update (part 1))
 
(One intermediate revision by one other user not shown)
Line 213: Line 213:
  
 
'''Default value, index 3:'''  
 
'''Default value, index 3:'''  
 +
{| class="list defaults"
 +
! {{tl|AutoCompleteCommand|||Member}}
 +
! Value
 +
|-
 +
| Command
 +
| "DisplayAllState"
 +
|-
 +
| Desc
 +
| "DisplayAllState <ClassName> (Display state names for all instances of classname)"
 +
|}
 +
 +
'''Default value, index 4:'''
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 224: Line 236:
 
|}
 
|}
  
−
'''Default value, index 4:'''  
+
'''Default value, index 5:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 236: Line 248:
 
|}
 
|}
  
−
'''Default value, index 5:'''  
+
'''Default value, index 6:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 248: Line 260:
 
|}
 
|}
  
−
'''Default value, index 6:'''  
+
'''Default value, index 7:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 260: Line 272:
 
|}
 
|}
  
−
'''Default value, index 7:'''  
+
'''Default value, index 8:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 272: Line 284:
 
|}
 
|}
  
−
'''Default value, index 8:'''  
+
'''Default value, index 9:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 284: Line 296:
 
|}
 
|}
  
−
'''Default value, index 9:'''  
+
'''Default value, index 10:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 296: Line 308:
 
|}
 
|}
  
−
'''Default value, index 10:'''  
+
'''Default value, index 11:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 308: Line 320:
 
|}
 
|}
  
−
'''Default value, index 11:'''  
+
'''Default value, index 12:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 320: Line 332:
 
|}
 
|}
  
−
'''Default value, index 12:'''  
+
'''Default value, index 13:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 332: Line 344:
 
|}
 
|}
  
−
'''Default value, index 13:'''  
+
'''Default value, index 14:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 344: Line 356:
 
|}
 
|}
  
−
'''Default value, index 14:'''  
+
'''Default value, index 15:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 356: Line 368:
 
|}
 
|}
  
−
'''Default value, index 15:'''  
+
'''Default value, index 16:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 368: Line 380:
 
|}
 
|}
  
−
'''Default value, index 16:'''  
+
'''Default value, index 17:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 380: Line 392:
 
|}
 
|}
  
−
'''Default value, index 17:'''  
+
'''Default value, index 18:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 392: Line 404:
 
|}
 
|}
  
−
'''Default value, index 18:'''  
+
'''Default value, index 19:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 404: Line 416:
 
|}
 
|}
  
−
'''Default value, index 19:'''  
+
'''Default value, index 20:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 416: Line 428:
 
|}
 
|}
  
−
'''Default value, index 20:'''  
+
'''Default value, index 21:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 428: Line 440:
 
|}
 
|}
  
−
'''Default value, index 21:'''  
+
'''Default value, index 22:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 440: Line 452:
 
|}
 
|}
  
−
'''Default value, index 22:'''  
+
'''Default value, index 23:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 452: Line 464:
 
|}
 
|}
  
−
'''Default value, index 23:'''  
+
'''Default value, index 24:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 464: Line 476:
 
|}
 
|}
  
−
'''Default value, index 24:'''  
+
'''Default value, index 25:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 476: Line 488:
 
|}
 
|}
  
−
'''Default value, index 25:'''  
+
'''Default value, index 26:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 488: Line 500:
 
|}
 
|}
  
−
'''Default value, index 26:'''  
+
'''Default value, index 27:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 500: Line 512:
 
|}
 
|}
  
−
'''Default value, index 27:'''  
+
'''Default value, index 28:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 512: Line 524:
 
|}
 
|}
  
−
'''Default value, index 28:'''  
+
'''Default value, index 29:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 524: Line 536:
 
|}
 
|}
  
−
'''Default value, index 29:'''  
+
'''Default value, index 30:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 536: Line 548:
 
|}
 
|}
  
−
'''Default value, index 30:'''  
+
'''Default value, index 31:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 548: Line 560:
 
|}
 
|}
  
−
'''Default value, index 31:'''  
+
'''Default value, index 32:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 560: Line 572:
 
|}
 
|}
  
−
'''Default value, index 32:'''  
+
'''Default value, index 33:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 572: Line 584:
 
|}
 
|}
  
−
'''Default value, index 33:'''  
+
'''Default value, index 34:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 584: Line 596:
 
|}
 
|}
  
−
'''Default value, index 34:'''  
+
'''Default value, index 35:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 596: Line 608:
 
|}
 
|}
  
−
'''Default value, index 35:'''  
+
'''Default value, index 36:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 608: Line 620:
 
|}
 
|}
  
−
'''Default value, index 36:'''  
+
'''Default value, index 37:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 620: Line 632:
 
|}
 
|}
  
−
'''Default value, index 37:'''  
+
'''Default value, index 38:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 632: Line 644:
 
|}
 
|}
  
−
'''Default value, index 38:'''  
+
'''Default value, index 39:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 644: Line 656:
 
|}
 
|}
  
−
'''Default value, index 39:'''  
+
'''Default value, index 40:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 656: Line 668:
 
|}
 
|}
  
−
'''Default value, index 40:'''  
+
'''Default value, index 41:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 668: Line 680:
 
|}
 
|}
  
−
'''Default value, index 41:'''  
+
'''Default value, index 42:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 680: Line 692:
 
|}
 
|}
  
−
'''Default value, index 42:'''  
+
'''Default value, index 43:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 692: Line 704:
 
|}
 
|}
  
−
'''Default value, index 43:'''  
+
'''Default value, index 44:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 704: Line 716:
 
|}
 
|}
  
−
'''Default value, index 44:'''  
+
'''Default value, index 45:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 716: Line 728:
 
|}
 
|}
  
−
'''Default value, index 45:'''  
+
'''Default value, index 46:'''
 +
{| class="list defaults"
 +
! {{tl|AutoCompleteCommand|||Member}}
 +
! Value
 +
|-
 +
| Command
 +
| "RestartLevel"
 +
|-
 +
| Desc
 +
| "RestartLevel (restarts the level)"
 +
|}
 +
 
 +
'''Default value, index 47:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 728: Line 752:
 
|}
 
|}
  
−
'''Default value, index 46:'''  
+
'''Default value, index 48:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 740: Line 764:
 
|}
 
|}
  
−
'''Default value, index 47:'''  
+
'''Default value, index 49:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 752: Line 776:
 
|}
 
|}
  
−
'''Default value, index 48:'''  
+
'''Default value, index 50:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 764: Line 788:
 
|}
 
|}
  
−
'''Default value, index 49:'''  
+
'''Default value, index 51:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 776: Line 800:
 
|}
 
|}
  
−
'''Default value, index 50:'''  
+
'''Default value, index 52:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 788: Line 812:
 
|}
 
|}
  
−
'''Default value, index 51:'''  
+
'''Default value, index 53:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 800: Line 824:
 
|}
 
|}
  
−
'''Default value, index 52:'''  
+
'''Default value, index 54:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 812: Line 836:
 
|}
 
|}
  
−
'''Default value, index 53:'''  
+
'''Default value, index 55:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 824: Line 848:
 
|}
 
|}
  
−
'''Default value, index 54:'''  
+
'''Default value, index 56:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 836: Line 860:
 
|}
 
|}
  
−
'''Default value, index 55:'''  
+
'''Default value, index 57:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 848: Line 872:
 
|}
 
|}
  
−
'''Default value, index 56:'''  
+
'''Default value, index 58:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 860: Line 884:
 
|}
 
|}
  
−
'''Default value, index 57:'''  
+
'''Default value, index 59:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 872: Line 896:
 
|}
 
|}
  
−
'''Default value, index 58:'''  
+
'''Default value, index 60:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}
Line 884: Line 908:
 
|}
 
|}
  
−
'''Default value, index 59:'''  
+
'''Default value, index 61:'''  
 
{| class="list defaults"
 
{| class="list defaults"
 
! {{tl|AutoCompleteCommand|||Member}}
 
! {{tl|AutoCompleteCommand|||Member}}

Latest revision as of 05:37, 17 January 2010

UDK Object >> UIRoot >> Interaction >> Console

Contents

Package: 
Engine
Within class: 
GameViewportClient
Direct subclass:
UTConsole
This class in other games:
RTNP, U1, UT, UE2Runtime, U2XMP, U2, UT2003, UT2004, UT3
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.

Constants[edit]

MaxHistory[edit]

Value: 16

  1. of command history to remember.

Properties[edit]

AutoCompleteIndex[edit]

Type: int

Modifiers: transient

Currently selected auto complete index

AutoCompleteIndices[edit]

Type: array<int>

Modifiers: transient

Current list of matching commands for auto-complete,

See: UpdateCompleteIndices()

AutoCompleteList[edit]

Type: array<AutoCompleteCommand>

Modifiers: transient

Full list of auto-complete commands and info

AutoCompleteTree[edit]

Type: AutoCompleteNode

Modifiers: native, transient


bAutoCompleteLocked[edit]

Type: bool

Modifiers: transient

Is the current auto-complete selection locked

bCaptureKeyInput[edit]

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[edit]

Type: bool

True while a control key is pressed.

bEnableUI[edit]

Type: bool

Modifiers: config


bIsRuntimeAutoCompleteUpToDate[edit]

Type: bool

Modifiers: transient

Do we need to rebuild auto complete?

bNavigatingHistory[edit]

Type: bool

Modifiers: transient

tracks whether the user is using arrows keys to navigate the history, so that auto-complete doesn't override

bRequireCtrlToNavigateAutoComplete[edit]

Type: bool

Modifiers: config

Should the user be required to hold ctrl to use the up/down arrows when navigating auto-complete

ConsoleBufferText[edit]

Type: UILabel


ConsoleKey[edit]

Type: name

Modifiers: globalconfig

The key which opens the console.

Default value: 'Tilde'

ConsoleTargetPlayer[edit]

Type: LocalPlayer

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

DefaultTexture_Black[edit]

Type: Texture2D


Default value: Texture2D'EngineResources.Black'

DefaultTexture_White[edit]

Type: Texture2D


Default value: Texture2D'EngineResources.WhiteSquareTexture'

History[edit]

Type: string

Array size: 16 (MaxHistory)

Modifiers: config

tracks previously entered console commands

HistoryBot[edit]

Type: int

Modifiers: config

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

Default value: -1

HistoryCur[edit]

Type: int

Modifiers: config

the index of the current position in the History array

HistoryTop[edit]

Type: int

Modifiers: config

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

LargeConsoleInput[edit]

Type: ConsoleEntry


LargeConsoleScene[edit]

Type: UIScene


ManualAutoCompleteList[edit]

Type: array<AutoCompleteCommand>

Modifiers: config

Manual list of auto-complete commands and info specified in BaseInput.ini

Default value, index 0:

Member Value
Command "Exit"
Desc "Exit (Exits the game)"

Default value, index 1:

Member Value
Command "Open"
Desc "Open <MapName> (Opens the specified map)"

Default value, index 2:

Member Value
Command "DisplayAll"
Desc "DisplayAll <ClassName> <PropertyName> (Display property values for instances of classname)"

Default value, index 3:

Member Value
Command "DisplayAllState"
Desc "DisplayAllState <ClassName> (Display state names for all instances of classname)"

Default value, index 4:

Member Value
Command "DisplayClear"
Desc "DisplayClear (Clears previous DisplayAll entries)"

Default value, index 5:

Member Value
Command "FlushPersistentDebugLines"
Desc "FlushPersistentDebugLines (Clears persistent debug line cache)"

Default value, index 6:

Member Value
Command "GetAll "
Desc "GetAll <ClassName> <PropertyName> (Log property values of all instances of classname)"

Default value, index 7:

Member Value
Command "GetAllState"
Desc "GetAllState <ClassName> (Log state names for all instances of classname)"

Default value, index 8:

Member Value
Command "Obj List "
Desc "Obj List <Class=ClassName> <Type=MetaClass> <Outer=OuterObject> <Package=InsidePackage> <Inside=InsideObject>"

Default value, index 9:

Member Value
Command "Obj ListContentRefs"
Desc "Obj ListContentRefs <Class=ClassName> <ListClass=ClassName>"

Default value, index 10:

Member Value
Command "Obj Classes"
Desc "Obj Classes (Shows all classes)"

Default value, index 11:

Member Value
Command "EditActor"
Desc "EditActor <Class=ClassName> or <Name=ObjectName> or TRACE"

Default value, index 12:

Member Value
Command "EditDefault"
Desc "EditDefault <Class=ClassName>"

Default value, index 13:

Member Value
Command "EditObject"
Desc "EditObject <Class=ClassName> or <Name=ObjectName> or <ObjectName>"

Default value, index 14:

Member Value
Command "ReloadCfg "
Desc "ReloadCfg <Class/ObjectName> (Reloads config variables for the specified object/class)"

Default value, index 15:

Member Value
Command "ReloadLoc "
Desc "ReloadLoc <Class/ObjectName> (Reloads localized variables for the specified object/class)"

Default value, index 16:

Member Value
Command "Set "
Desc "Set <ClassName> <PropertyName> <Value> (Sets property to value on objectname)"

Default value, index 17:

Member Value
Command "Show BOUNDS"
Desc "Show BOUNDS (Displays bounding boxes for all visible objects)"

Default value, index 18:

Member Value
Command "Show BSP"
Desc "Show BSP (Toggles BSP rendering)"

Default value, index 19:

Member Value
Command "Show COLLISION"
Desc "Show COLLISION (Toggles collision rendering)"

Default value, index 20:

Member Value
Command "Show COVER"
Desc "Show COVER (Toggles cover rendering)"

Default value, index 21:

Member Value
Command "Show DECALS"
Desc "Show DECALS (Toggles decal rendering)"

Default value, index 22:

Member Value
Command "Show FOG"
Desc "Show FOG (Toggles fog rendering)"

Default value, index 23:

Member Value
Command "Show LEVELCOLORATION"
Desc "Show LEVELCOLORATION (Toggles per-level coloration)"

Default value, index 24:

Member Value
Command "Show PATHS"
Desc "Show PATHS (Toggles path rendering)"

Default value, index 25:

Member Value
Command "Show POSTPROCESS"
Desc "Show POSTPROCESS (Toggles post process rendering)"

Default value, index 26:

Member Value
Command "Show SKELMESHES"
Desc "Show SKELMESHES (Toggles skeletal mesh rendering)"

Default value, index 27:

Member Value
Command "Show TERRAIN"
Desc "Show TERRAIN (Toggles terrain rendering)"

Default value, index 28:

Member Value
Command "Show VOLUMES"
Desc "Show VOLUMES (Toggles volume rendering)"

Default value, index 29:

Member Value
Command "Show SPLINES"
Desc "Show SPLINES (Toggles spline rendering)"

Default value, index 30:

Member Value
Command "Stat FPS"
Desc "Stat FPS (Shows FPS counter)"

Default value, index 31:

Member Value
Command "Stat UNIT"
Desc "Stat UNIT (Shows hardware unit framerate)"

Default value, index 32:

Member Value
Command "Stat LEVELS"
Desc "Stat LEVELS (Displays level streaming info)"

Default value, index 33:

Member Value
Command "Stat GAME"
Desc "Stat GAME (Displays game performance stats)"

Default value, index 34:

Member Value
Command "Stat MEMORY"
Desc "Stat MEMORY (Displays memory stats)"

Default value, index 35:

Member Value
Command "Stat XBOXMEMORY"
Desc "Stat XBOXMEMORY (Displays Xbox memory stats while playing on PC)"

Default value, index 36:

Member Value
Command "Stat PHYSICS"
Desc "Stat PHYSICS (Displays physics performance stats)"

Default value, index 37:

Member Value
Command "Stat STREAMING"
Desc "Stat STREAMING"

Default value, index 38:

Member Value
Command "Stat COLLISION"
Desc "Stat COLLISION"

Default value, index 39:

Member Value
Command "Stat PARTICLES"
Desc "Stat PARTICLES"

Default value, index 40:

Member Value
Command "Stat SCRIPT"
Desc "Stat SCRIPT"

Default value, index 41:

Member Value
Command "Stat AUDIO"
Desc "Stat AUDIO"

Default value, index 42:

Member Value
Command "Stat ANIM"
Desc "Stat ANIM"

Default value, index 43:

Member Value
Command "Stat NET"
Desc "Stat NET"

Default value, index 44:

Member Value
Command "Stat LIST"
Desc "Stat LIST Groups/Sets/Group (List groups of stats, saved sets, or specific stats within a specified group)"

Default value, index 45:

Member Value
Command "ListTextures"
Desc "ListTextures (Lists all loaded textures and their current memory footprint)"

Default value, index 46:

Member Value
Command "RestartLevel"
Desc "RestartLevel (restarts the level)"

Default value, index 47:

Member Value
Command "ListSounds"
Desc "ListSounds (Lists all the loaded sounds and their memory footprint)"

Default value, index 48:

Member Value
Command "ListWaves"
Desc "ListWaves (List the WaveInstances and whether they have a source)"

Default value, index 49:

Member Value
Command "ListSoundClasses"
Desc "ListSoundClasses (Lists a summary of loaded sound collated by class)"

Default value, index 50:

Member Value
Command "ListSoundModes"
Desc "ListSoundModes (Lists loaded sound modes)"

Default value, index 51:

Member Value
Command "ListAudioComponents"
Desc "ListAudioComponents (Dumps a detailed list of all AudioComponent objects)"

Default value, index 52:

Member Value
Command "ListSoundDurations"
Desc "ListSoundDurations"

Default value, index 53:

Member Value
Command "PlaySoundCue"
Desc "PlaySoundCue (Lists a summary of loaded sound collated by class)"

Default value, index 54:

Member Value
Command "PlaySoundWave"
Desc "PlaySoundWave"

Default value, index 55:

Member Value
Command "SetSoundMode"
Desc "SetSoundMode <ModeName>"

Default value, index 56:

Member Value
Command "DisableLowPassFilter"
Desc "DisableLowPassFilter"

Default value, index 57:

Member Value
Command "DisableEQFilter"
Desc "DisableEQFilter"

Default value, index 58:

Member Value
Command "IsolateDryAudio"
Desc "IsolateDryAudio"

Default value, index 59:

Member Value
Command "IsolateReverb"
Desc "IsolateReverb"

Default value, index 60:

Member Value
Command "ResetSoundState"
Desc "ResetSoundState (Resets volumes to default and removes test filters)"

Default value, index 61:

Member Value
Command "ModifySoundClass"
Desc "ModifySoundClass <SoundClassName> Vol=<new volume>"

MaxScrollbackSize[edit]

Type: int

Modifiers: globalconfig

Visible Console stuff

Default value: 1024

MiniConsoleInput[edit]

Type: ConsoleEntry


MiniConsoleScene[edit]

Type: UIScene


SBHead[edit]

Type: int

Where in the scrollback buffer are we

SBPos[edit]

Type: int

Where in the scrollback buffer are we

Scrollback[edit]

Type: array<string>

Holds the scrollback buffer

TypedStr[edit]

Type: string

The command the user is currently typing.

TypedStrPos[edit]

Type: int

Current position in TypedStr

TypeKey[edit]

Type: name

Modifiers: globalconfig

The key which opens the typing bar.

Default value: 'Tab'

Default values[edit]

Property Value
OnReceivedNativeInputChar InputChar
OnReceivedNativeInputKey InputKey

Structs[edit]

AutoCompleteCommand[edit]

Modifiers: native

string Command 
string Desc 

AutoCompleteNode[edit]

Modifiers: native

Node for storing an auto-complete tree based on each char in the command

int IndexChar 
Char for node in the tree
array<int> AutoCompleteListIndices 
Indicies into AutoCompleteList for commands that match to this level
array<pointer{FAutoCompleteNode}> ChildNodes 
Children for further matching

Functions[edit]

Native functions[edit]

BuildRuntimeAutoCompleteList[edit]

final native function BuildRuntimeAutoCompleteList (optional bool bForce)


UpdateCompleteIndices[edit]

native function UpdateCompleteIndices ()


Events[edit]

OutputText[edit]

event OutputText (coerce string Text)

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[edit]

AppendInputText[edit]

function AppendInputText (string Text)

appends the specified text to the string of typed text

ClearOutput[edit]

function ClearOutput ()

Clears the console output buffer.

ConsoleCommand[edit]

function ConsoleCommand (string Command)

Executes a console command.

Parameters:

  • Command - The command to execute.

FlushPlayerInput[edit]

function FlushPlayerInput ()

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

Initialized[edit]

function Initialized ()

Overrides: Interaction.Initialized

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

InputChar[edit]

function bool InputChar (int ControllerId, string Unicode)

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[edit]

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

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[edit]

function bool IsUIConsoleOpen ()


IsUIMiniConsoleOpen[edit]

function bool IsUIMiniConsoleOpen ()


OutputTextLine[edit]

function OutputTextLine (coerce string Text)

Prints a single line of text to the console.

Parameters:

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

PostRender_Console[edit]

function PostRender_Console (Canvas Canvas)


ProcessControlKey[edit]

function bool ProcessControlKey (name Key, Object.EInputEvent Event)

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

PurgeCommandFromHistory[edit]

function PurgeCommandFromHistory (string Command)

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[edit]

function SetCursorPos (int Position)


SetInputText[edit]

function SetInputText (string Text)


StartTyping[edit]

function StartTyping (coerce string Text)

Opens the typing bar with text already entered.

Parameters:

  • Text - The text to enter in the typing bar.

States[edit]

Open[edit]

Open.BeginState[edit]

event BeginState (name PreviousStateName)

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[edit]

event EndState (name NextStateName)

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[edit]

event PostRender_Console (Canvas Canvas)

Overrides: PostRender_Console (global)


Open.InputChar[edit]

function bool InputChar (int ControllerId, string Unicode)

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[edit]

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

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[edit]

This state is used when the typing bar is open.

Typing.BeginState[edit]

event BeginState (name PreviousStateName)

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[edit]

event EndState (name NextStateName)

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[edit]

event PostRender_Console (Canvas Canvas)

Overrides: PostRender_Console (global)


Typing.InputChar[edit]

function bool InputChar (int ControllerId, string Unicode)

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[edit]

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

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.
Retrieved from "https://wiki.beyondunreal.com/UE3:Console_(UDK)?oldid=40767"