Useful console commands

This page shows a table of useful console commands and what they are used for.

Open console command overlay

Press the ` key (backtick) shortcut
(often re-bound to the INSERT or HOME key)

This can be done at runtime.

Change keyboard shortcut

Open Edit → Project settings
Search for Engine → Input → Console
Edit key value

Changing the shortcut in the Editor's preferences will not be sufficient. The shortcut might not work in Live mode.

Setting console commands via the API

Use the ExecuteConsoleCommand Engine API - Call
Set the Command string to [Command] [value] for example r.PostProcessing.Log 1

Learn more about Using the Pixotope API

Setting console commands via the Control panel

Download an example control panel

Trigger a console command.pxpanel

or follow these steps:

Steps to setting console commands via the Control panel

Listen to any API log message
Add a widget using this action
Set this message to be a Trigger so it sends values
Update the Topic and the Message
- Update the Target and RespondTo machine names (Render1) with your machine names
- Update the command (r.depthoffieldquality)
- Update the value ({{value}})
  - Use a Dynamic Argument like above or a hard coded value

Topic

JSON

{
  "Type": "Call",
  "Target": "Render1-Engine",
  "RespondTo": "Render1-Director",
  "Method": "ExecuteConsoleCommand",
  "ID": "c68733f9-1ad6-45c0-ad15-3aa7acde6ca4"
}

Message

With dynamic argument

JSON

{
  "Params": {
    "Command": "r.depthoffieldquality {{value}}"
  }
}

With static value

JSON

{
  "Params": {
    "Command": "r.depthoffieldquality 2"
  }
}

Learn more about Triggering API calls from the Control panel

Pixotope console commands

Console command	Details	Default
FrameMatcher.AllowReplacement	Replace missing packets, detected using packet numbers. Either with copies or interpolated	1
FrameMatcher.AllowInterpolation	Replace missing packets with interpolation. CTSReceiverCameraTracker.bEnablePacketReplacement must be 1	1
FrameMatcher.Method	Overrides frame matching method set in Syncing panel. Use FrameMatcher.Method ? to see more information.	-1
stat PixotopeCameraTrackerComponent	See camera tracker component stats
stat ctsreceiver	Ctsreceiver plugin stats must be called after Stat PixotopeCameraTrackerComponent
CTSReceiver.EnableCrosshair	Turn on crosshair for tuning decentering	0
CTSReceiver.AllowCrosshair	Allow seeing the crosshair when a true value, when false no crosshairs are allowed even if CTSReceiver.EnableCrosshair is true or Show Crosshair in Director is checked.	1
CTSReceiver.EnableDistortion	Enable distortion	1
CTSReceiver.EnableFocus	Set to 0 to disable dof, set to 1 or another true integer to enable dof	1
showflag.depthoffield	Allows to override a specific showflag (works in editor and game, "show" only works in game and UI only in editor) Useful to run a build many time with the same showflags (when put in consolevariables.ini like "showflag.abc=0") 0: force the showflag to be OFF 1: force the showflag to be ON 2: do not override this showflag (default)	2
r.depthoffieldquality	Allows to adjust the depth of field quality. Currently only fully affects BokehDOF. GaussianDOF is either 0 for off, otherwise on. 0: Off 1: Low 2: high quality (default, adaptive, can be 4x slower) 3: very high quality, intended for non realtime cutscenes, CircleDOF only (slow) 4: extremely high quality, intended for non realtime cutscenes, CircleDOF only (very slow)	2
r.HairStrands.Visibility.UseCustomDepth	Enable to mitigate the issue of hair being visible through a VS plane 1 - enable \| 0 - disable	0
r.PostProcessing.DistortionUpscale	Change the lens distortion filtering algorithm: 0 - nearest 1 - bilinear (default) 2 - Catmull-Rom 3 - Lanczos	1
r.PostProcessing.Log	Enable lens distortion filtering to be done in logarithmic color space 1 - enable \| 0 - disable	0
r.PostProcessing.LUTToVideoAsWell	When enabled applies the AR LUT also on the video 1 - enable \| 0 - disable	0
r.SeparateShadowMask	Use separate shadow mask rendering to avoid light function problems	0
CameraTracker.DisableNcamMapBackplane	A redundant method to disable the backplane with NCAM MAP distortion. Set to 0 to include the backplane	1
CameraTracker.Overscan	When greater than 0 the calculated overscan is multiplied by this, use if more overscan is needed.	-1
CameraTracker.ResetStats 1	Command to reset stats enabled by stat PixotopeCameraTrackerComponent to initial values.	0
Pixotope.PrintCameraTracking	Set to 1 to print incoming camera tracking packets in editor viewport	0