Generated on 1/4/2026 9:59:59 PM
Console commands can be executed in PatchXR using the Console Block, Execute Block, or Cmd Block.
Commands are generally written as:
CommandName <parameter1> <parameter2>
Parameters are separated by spaces.
1.5, 120)"My World Name")true or false (or 1/0)Setting the Tempo:
SetTempo 128
Changing Background Color (HSV):
BgColorHSV 0.5 1 0.2
Making a floater message
ToasterMessage "Hello, world!"
AbletonLinkEnabled · AbletonLinkLatency · SetAudioEngineProcessingEnabled · SetBufferSize · SetEngineBlockSize · SetGhostRecordingGain · SetMetronomeEnabled · SetRecordVoice · SetTempo
AmbientColorHSV · AmbientColorRGB · BGColor1 · BGColor2 · BgColorHSV · FadeToBlack · FogColorHSV · FogColorRGB · FogFalloffMode · PlaceReflectionProbe · SetAntiAliasing · SetColorPalette · SetMainLight · SetPixelLightCount · SetPostProcessing · SetShadowDistance · SetShadowQuality
AllowPlayerScaling · AllowPlayerTilt · AllowSwimming · SetGlobalSnapTurn · SetGlobalSwimScaling · SetGlobalTeleport · SetGlobalUpsideDown · SetPlayerHeadPosition · SetPlayerLimit · SetPlayerPosition · SetPlayerScale · SetPlayerScaleMultiplier · SetWorldSnapTurn · SetWorldSwimScaling · SetWorldTeleport · SetWorldUpsideDown · SwimToGazeAngle · SwimToGazeWeight
MPLobby · MPPopulatedWorld · MPRandom · MPSession · MPWorld · MPWorldLast · SetPause · SetRegion · TestMP
AllowControlPanel · AllowEditing · AllowForking · AllowJoltPatching · AllowOpenBubbles · AllowRadialMenu · Autosaving · DisplayButtonText · DisplayWirePlayMode · EditModeNumbers · HideAll · LockPatch · PlayModeNumbers · RemoveControlPanel · SetGridEnabled · SetRadialMenuProfile · ShowAllHidden · ShowHidden · ShowTooltips
GenerateAudio · GenerateImage · GenerateModel · GenerateModelFromImage · GenerateSkybox · GetSkyboxStyles
TimelineLength · TimelineLoop · TimelinePlay · TimelineStop
PlaceAllWindows · SetMixedRealityMode · SetSceneBounciness · SetSyncPhysicalSpace
AddRelatedWorld · LoadFromCloud · NextScene · OpenURL · PreloadWorld · PreviousScene · Script
HighlightControllerButton · SetControllersVisible · ShowHub · ToasterMessage
DisableGhostHitInteractions · DisableGhostInteractions · RGR
AllowControllerTipHide · AssignAccessLevel · CallEvent · ChangeFogColor · ChangeFogDistance · CheckChangeRate · CurrentStateToTemp · EnableBeta · GetCpuUsage · Go · GoToTemp · LoadRPMAvatar · MakeCircle · OptoutAnalytics · PhysicsClearOverride · PhysicsFreeze · PhysicsReset · PhysicsSavePositions · PhysicsUnfreeze · QuestBoostThreshold · QuestUnBoostThreshold · Save · SelectAll · SendAnalyticsEvent · SetGameMode · SetMarbleLifeTime · SetMarbleMaxCount · SetMarbleMaxDistance · SetPowerBlockVisible · SetTime · SetTimeScale · SetWorldResolutionMultiplier · ShowBlockList · SpawnAsync · Test123 · TestInvite · TestRequest
Parameters: bool value
Category: Audio & Tempo
Console command to enable or disable ableton link.
Parameters: Double value
Category: Audio & Tempo
Console command to set the ableton link latency compensation.
Parameters: string pid
Category: World Loading & Navigation
Command to specify which worlds are related to the current one. Related worlds will show up earlier in suggestions.
Parameters: bool left, bool right
Category: Other
Parameters: bool enable
Category: Editing & Patch Settings
De/activate the ability to open the control panel / Library. We keep the name as control panel for compatibility.
Parameters: bool enable
Category: Editing & Patch Settings
Set false to do not allow use edit mode
Parameters: bool enable
Category: Editing & Patch Settings
Set false to do not allow users to save downloaded world
Parameters: bool isAllowed
Category: Editing & Patch Settings
Enable Jolt wiring in playmode on visible blocks
Parameters: bool enable
Category: Editing & Patch Settings
De/activate the ability to open bubbles in the current patch.
Parameters: bool enable
Category: Player & Movement
Parameters: bool enable
Category: Player & Movement
Parameters: bool enable
Category: Editing & Patch Settings
De/activate the ability to open the radial menu.
Parameters: bool enable
Category: Player & Movement
De/activate swimming in current patch.
Parameters: float H, float S, float V
Category: Visuals & Environment
Parameters: float r, float g, float b
Category: Visuals & Environment
Parameters: int level
Category: Other
Parameters: bool enable
Category: Editing & Patch Settings
Enable/disable the autosaving feature
Parameters: float hue, float sat, float value
Category: Visuals & Environment
Parameters: float hue, float sat, float value
Category: Visuals & Environment
Parameters: float H, float S, float V
Category: Visuals & Environment
Parameters: int handle, float value
Category: Other
Parameters: color col
Category: Other
Parameters: float distance
Category: Other
Parameters: float newValue
Category: Other
Category: Other
Parameters: bool val
Category: Ghosts
Parameters: bool val
Category: Ghosts
Parameters: bool val
Category: Editing & Patch Settings
Should touching button display more details about the button functionality.
Parameters: bool enable
Category: Editing & Patch Settings
Should we display wires in Play mode (default true)
Parameters: bool val
Category: Editing & Patch Settings
Should we display numbers in Edit Mode.
Parameters: bool enable
Category: Other
Switch beta mode
Parameters: float time
Category: Visuals & Environment
Parameters: float H, float S, float V
Category: Visuals & Environment
Parameters: float r, float g, float b
Category: Visuals & Environment
Parameters: int mode
Category: Visuals & Environment
Change how the fog varies according to the distance.
Parameters: int seconds, int steps, string prompt
Category: Gen AI
Parameters: string prompt
Category: Gen AI
Parameters: string asset_id_or_url_or_path, [caption:"text"], [shape_only:true/false], [remove_bg:true/false], [steps:int]
Category: Gen AI
Parameters: string prompt
Category: Gen AI
Parameters: int style_id, string prompt
Category: Gen AI
Category: Other
Parameters: string command
Category: Other
Category: Other
Category: Editing & Patch Settings
This method changes Visibility parameter for every block at scene.
Parameters: string controller, string button, float glow, float freq
Category: Controllers & UI
Highlight a button on one of the controllers. Syntax: highlightcontrollerbutton [left|right] [button] [strength] [frequency] e.g. highlightcontrollerbutton left hub 0.8 2 available buttons are: pistoltrigger grip thumbstick button1 button2 hub Use strength zero to turn off the highlight.
Parameters: string productId
Category: World Loading & Navigation
Load world from the cloud used by magic portals in Landing patch
Parameters: string url
Category: Other
Parameters: bool isAllowed
Category: Editing & Patch Settings
Make all blocks locked or unlocked
Parameters: string blockName, int count, float r
Category: Other
Spawn a bunch of object arranged in a circle around 0, 0, 0
Parameters: string productId
Category: Multiplayer
Show list of rooms for specific world
Parameters: string productId, string sessionNameModifier, Action1 customJoin`
Category: Multiplayer
Join most populated session in multiplayer
Category: Multiplayer
Join to random session
Parameters: string productId
Category: Multiplayer
Join to session with unique name
Parameters: string productId
Category: Multiplayer
Join to most oldest room that has space
Parameters: string productId
Category: Multiplayer
Join to latest room
Parameters: string filePath
Category: World Loading & Navigation
Parameters: string url
Category: World Loading & Navigation
Parameters: bool enable
Category: Other
Disable analytics across all sessions
Category: Other
Clears any manual physics freeze override and returns to automatic game mode logic. In multiplayer, broadcasts to all players.
Category: Other
Freezes physics simulation, making all physics objects kinematic. Overrides the automatic game mode logic until PhysicsUnfreeze or PhysicsClearOverride is called. In multiplayer, broadcasts to all players.
Category: Other
Resets all physics objects to their edit mode positions and zeroes velocities. Useful for resetting physics simulations without toggling play/edit mode. In multiplayer, broadcasts to all players.
Category: Other
Saves current positions of all physics objects as their new starting positions. Useful for updating the reset point after objects have settled or been repositioned. In multiplayer, broadcasts to all players.
Category: Other
Unfreezes physics simulation, allowing physics objects to move again. Overrides the automatic game mode logic until PhysicsFreeze or PhysicsClearOverride is called. In multiplayer, broadcasts to all players.
Category: Mixed Reality
Category: Visuals & Environment
Parameters: bool val
Category: Editing & Patch Settings
Should we display numbers in Play Mode.
Parameters: string world
Category: World Loading & Navigation
Preload worlds from the cloud at patch was started
Parameters: string filePath
Category: World Loading & Navigation
Parameters: float value
Category: Other
Parameters: float value
Category: Other
Category: Editing & Patch Settings
Command to remove control panel from current scene Requires for intro world, mask editor and other scenes with limited interaction
Category: Ghosts
Temporary remove restrictions for ghosts in current world
Category: Other
Parameters: string filename
Category: World Loading & Navigation
Load script in json format
Category: Other
Parameters: string message
Category: Other
Send analytics message to cloud. Message will be put with a name executeEvent and parameter name EventName (Gad set these names on cloud side)
Parameters: int v
Category: Visuals & Environment
Parameters: bool value
Category: Audio & Tempo
Parameters: int bufferSize
Category: Audio & Tempo
Parameters: string colorList
Category: Visuals & Environment
Parameters: bool enable
Category: Controllers & UI
This method makes controllers for current user in/visible.
Parameters: int blockSize
Category: Audio & Tempo
Change the size of buffer blocks inside audio engine
Parameters: string mode
Category: Other
Parameters: float gain
Category: Audio & Tempo
Sets the recording gain in db.
Parameters: bool enable
Category: Player & Movement
Enable or disable snap turn in player preference settings.
Parameters: bool enable
Category: Player & Movement
Enable or disable Swim Scaling in player preference settings.
Parameters: int mode
Category: Player & Movement
-1: do nothing 0: no joystick up movement 1: teleport 2: jetpack
Parameters: bool enable
Category: Player & Movement
Enable or disable swim upside down in player preference settings.
Parameters: bool enable
Category: Editing & Patch Settings
Enables or disables snapping to the grid when blocks are moved.
Parameters: float x, float y, float z, float r, float g, float b
Category: Visuals & Environment
Parameters: float lifetime_seconds
Category: Other
Parameters: int maxMarbleCount
Category: Other
Parameters: float distance
Category: Other
Parameters: bool value
Category: Audio & Tempo
Console command for enabling or disabling the metronome.
Parameters: string mode
Category: Mixed Reality
Sets the mixed reality mode to used. See the MixedRealityMode enum for available options.
Parameters: bool pause
Category: Multiplayer
Parameters: int v
Category: Visuals & Environment
Parameters: float x, float y, float z, float rx, float ry, float rz, float rw
Category: Player & Movement
Parameters: float minX, float maxX, float minY, float maxY, float minZ, float maxZ
Category: Player & Movement
Stops player movement when reaching the boundaries. Boundaries in meters. SetPlayerLimit 0 0 0 0 0 0 will result in no boundaries at all. Display as red wired box in the editor scene view.
Parameters: float x, float y, float z
Category: Player & Movement
Parameters: float newScale
Category: Player & Movement
Parameters: float newScale
Category: Player & Movement
Parameters: int v
Category: Visuals & Environment
Parameters: bool val
Category: Other
Parameters: int profile
Category: Editing & Patch Settings
Parameters: bool enable
Category: Audio & Tempo
Set a value controlling if ghost voice recording should be enabled.
Parameters: string region
Category: Multiplayer
Force switching home multiplayer region for the player
Parameters: float floorCeilingBounciness, float wallsWindowsDoorsBounciness, float desksOthersBounciness
Category: Mixed Reality
Sets the bounciness of the different kinds of objects in the mixed reality scene.
Parameters: float v
Category: Visuals & Environment
Parameters: int v
Category: Visuals & Environment
Parameters: bool val
Category: Mixed Reality
Parameters: Double x
Category: Audio & Tempo
Parameters: Double x
Category: Other
Parameters: float val
Category: Other
Parameters: float multiplier
Category: Other
Parameters: bool enable
Category: Player & Movement
Force snap turn feature for current world
Parameters: bool enable
Category: Player & Movement
Force Swim Scaling feature for current world
Parameters: int mode
Category: Player & Movement
-1: not forcing 0: forcing no joystick up movement 1: teleport 2: jetpack
Parameters: bool enable
Category: Player & Movement
Force swim upside down feature for current world
Parameters: bool show
Category: Editing & Patch Settings
Category: Other
Parameters: bool show
Category: Editing & Patch Settings
Parameters: bool toBeOpened
Category: Controllers & UI
Open hub from the console
Parameters: bool visibility
Category: Editing & Patch Settings
Show or hide tooltips in current patch.
Category: Gen AI
Parameters: string sv
Category: Other
Parameters: float val
Category: Player & Movement
Parameters: float val
Category: Player & Movement
Category: Other
Category: Other
Category: Multiplayer
Console commands to create and join to mp sessions
Category: Other
Parameters: float value
Category: Timeline
Console command to stop timeline playback.
Parameters: bool value
Category: Timeline
Console command to stop timeline playback.
Category: Timeline
Console command to start timeline playback.
Category: Timeline
Console command to stop timeline playback.
Parameters: string s
Category: Controllers & UI