Command System

The machine-readable command schema is generated from server registrations and committed in docs/reference/command_schema.json. Use python tools/command_schema/generate_schema.py to regenerate it after command changes.

Unreal Engine 4 has some built-in commands to help game development. These commands can be typed into a built-in console. Using these commands, a developer can profile the game performance and view debug information. To invoke the built-in console of a game, type the ` key (the key above tab).

UnrealCV provides commands useful for computer vision researchers. What is more, these commands can be used by an external program. A built-in command can also be used using the special command vrun.

Console command completion

When the Unreal Engine console is open, type an UnrealCV verb such as vget or vset to see registered command suggestions. Each suggestion includes the command template and the first line of its help text. UnrealCV also provides executable argument examples and camera-index examples such as vget /camera/0/location.

The completion list is generated from the live command dispatcher and refreshed after UnrealCV registers its command handlers, so newly registered commands appear without maintaining a separate console command list.

Command cheatsheet

See this ipython notebook to see an imcomplete demo of available commands.

1. Camera operation

See Source/UnrealCV/Private/Commands/CameraHandler.h(.cpp) for more details.

vget /camera/[id]/location

(v0.2) Get camera location [x, y, z]

vget /camera/[id]/rotation

(v0.2) Get camera rotation [pitch, yaw, roll]

vset /camera/[id]/location [x] [y] [z]

(v0.2) Set camera location [x, y, z]

vset /camera/[id]/rotation [pitch] [yaw] [roll]

(v0.2) Set camera rotation [pitch, yaw, roll]

vget /camera/[id]/[viewmode]

(v0.2) Get [viewmode] from the [id] camera, for example: vget /camera/0/depth

vget /camera/[id]/[viewmode] [filename]

(v0.2) Same as the above, with an extra parameter for filename

filename:: Filename is where the file will be stored.
example:: vget /camera/0/lit lit.png

vget /camera/[id]/[viewmode] [format]

(v0.3.7) Support binary data format

format:: If only file format is specified, the binary data will be returned through socket instead of being saved as a file.
example:: vget /camera/0/lit png

vget /camera/[id]/object_mask

(v0.2) The object mask is captured by first switching the viewmode to object_mask mode, then take a screenshot

vget /camera/[id]/lit_shared

Capture the lit image into a Windows named shared-memory region and return JSON metadata containing its name, shape, dtype, and byte size.

vget /camera/[id]/depth_shared

Capture the depth image into Windows shared memory as a row-major float32 array and return JSON metadata.

vget /camera/[id]/normal_shared

Capture the surface-normal image into Windows shared memory as BGRA uint8 pixels and return JSON metadata.

vget /camera/[id]/object_mask_shared

Capture the object mask into Windows shared memory as BGRA uint8 pixels and return JSON metadata. seg_shared is an alias.

vset /viewmode [viewmode]

(v0.2) Set ViewMode to (lit, normal, depth, object_mask)

vget /viewmode

(v0.2) Get current ViewMode

vget /camera/[id]/pose

(v0.3.10) Get camera location [x, y, z] and rotation [pitch, yaw, roll]

vset /camera/[id]/pose [x] [y] [z] [pitch] [yaw] [roll]

(v0.3.10) Teleport camera to location [x, y, z] and rotation [pitch, yaw, roll]

vget /camera/[id]/horizontal_fieldofview

(v0.3.10) Get camera horizontal field of view. This cmd is deprecated, use vget /camera/[uint]/fov instead (v0.4.0).

vset /camera/[id]/horizontal_fieldofview [FOV]

(v0.3.10) Set camera horizontal field of view. This cmd is deprecated, use vset /camera/[uint]/fov [FOV] instead (v0.4.0).

vget /camera/[id]/vis_depth npy

(v0.3.10)

vget /camera/[id]/plane_depth npy

(v0.3.10)

vget /cameras

(v0.4.0) List all cameras in the scene

vset /cameras/spawn

(v0.4.0) Spawn a new camera

vset /camera/[id]/size [width] [height]

(v0.4.0) Set the size of the camera image

vget /camera/[id]/size

(v0.4.0) Get the size of the camera image

vset /camera/[id]/projection_type [type]

(v0.4.0) Set the projection type of the camera, type can be perspective or orthographic

vset /camera/[id]/ortho_width [width]

(v0.4.0) Set the orthographic width of the camera

2. Object interaction

See Source/UnrealCV/Private/Commands/ObjectHandler.h(.cpp) for more details

vget /objects

(v0.2) Get the name of all objects

vget /object/[obj_name]/color

(v0.2) Get the labeling color of an object (used in object instance mask)

vset /object/[obj_name]/color [r] [g] [b]

(v0.2) Set the labeling color of an object

vset /object/[obj_name]/show

(v0.3.10) Show object

vset /object/[obj_name]/hide

(v0.3.10) Hide object

vget /object/[obj_name]/mobility

(v0.3.10) Get object mobility

vget /object/[obj_name]/material

(editor) List material path for each slot on the first StaticMeshComponent on the object

vset /object/[obj_name]/material [slot] [material_path]

(editor) Assign material_path to slot on the first StaticMeshComponent (UE object path, e.g. /Game/Materials/M_Material.M_Material)

vset /objects/spawn [class_name] [obj_name]

(v0.4.0) Spawn an object with class name and object name. It can also be used to create a new camera, for example:

vset /objects/spawn FusionCameraActor Cam_1 - create a new camera named Cam_1
vset /objects/spawn StereoCameraActor StereoCam_1 - create a new stereo camera named StereoCam_1

vset /objects/spawn [class_name] [x] [y] [z]

(v1.1.0) Spawn an object at a world-space location.

vset /objects/spawn [class_name] [obj_name] [x] [y] [z]

(v1.1.0) Spawn a named object at a world-space location. The same coordinate forms are available for vset /objects/spawn_cube.

vset /object/[obj_name]/destroy

(v0.4.0) Destroy object

vset /object/[obj_name]/name [new_obj_name]

(v0.4.0) Rename object

vget /object/[obj_name]/scale

(v0.4.0) Get object scale

vset /object/[obj_name]/scale [x] [y] [z]

(v0.4.0) Set object scale

vset /object/[obj_name]/name [new_obj_name]

(v0.4.0) Rename object

vget /object/[obj_name]/uclass_name

(v0.4.0) Get UClass name of an object

vget /object/[obj_name]/bounds

(v0.4.0) Get object bounds in the world coordinate, format is [minx, y, z, maxx, y, z]

vget /object/[obj_name]/vertex_location

(v0.4.0) Get the vertex location of an object

vget /object/[obj_name]/bones

(v1.1.0) Return all bone transforms in component space.

vget /object/[obj_name]/bones [component|world]

(v1.1.0) Return all bone transforms in the selected coordinate space.

vget /object/[obj_name]/bones [bone_1,bone_2,…] [component|world]

(v1.1.0) Return skeletal or poseable mesh bone transforms as JSON. The default is all bones in component space. This command provides world-space bone locations for pose and keypoint workflows. If an actor has multiple eligible mesh components, only the first poseable mesh component, or otherwise the first skeletal mesh component, is queried.

3. Plugin commands

See Source/UnrealCV/Private/Commands/PluginHandler.h(.cpp) for more details.

vget /unrealcv/status: (v0.2) Get the status of UnrealCV plugin
vget /unrealcv/help: (v0.2) List all available commands and their help message
vget /unrealcv/commands: Return all command templates currently registered in the UnrealCV command dispatcher. The result is stable, sorted plain text with exactly one command template per line and no heading or description. Clients can use this output for runtime capability detection.
vget /unrealcv/version: (v0.3.10) Get the version of UnrealCV plugin
vget /scene/name: (v0.3.10) Get the name of this scene
vget /level/name: (v0.3.10) Get the name of the current level

4. Action commands

See Source/UnrealCV/Private/Commands/ActionHandler.h(.cpp)

vset /action/keyboard [key_name] [delta]: (v0.3.6) Valid key_name can be found in here
vset /action/game/pause: (v0.3.10) Pause the game
vget /action/game/is_paused: (v0.3.10) Check if the game is paused
vset /action/game/resume: (v0.3.10) Resume the game
vset /action/game/level [level_name]: (v0.3.10) Open a new level
vset /action/input/enable: (v0.3.10) Enable input
vset /action/input/disable: (v0.3.10) Disable input
vset /action/eyes_distance [eye_distance]: (v0.3.10) Set the eye distance between left eye and right eye (camera 1). This command might be marked as deprecated when we finish multiple camera support.

5. Run UE4 built-in commands

vrun [cmd]: (v0.3) This is a special command used to execute Unreal Engine built-in commands. UE4 provides some built-in commands for development and debug. They are not very well documented, but very useful.

A few examples are:

stat FPS - show current frame rate
shot - take a screenshot
show Material - toggle the display of Material

These commands can be executed in the UE4 console. If you want to use them in UnrealCV, you can prefix these commands with vrun stat FPS.

6. Run Blueprint commands

vbp [obj_name] [func_name] [arg1] [arg2] …

(v0.4.0) This is a special command used to execute Blueprint commands. Blueprint is a visual programming language in UE4. It is widely used in UE4 game development. UnrealCV provides a way to call Blueprint functions from the command line.

A few examples are:

vbp BP_Player_C GetActorLocation - Get the location of the player
vbp BP_Player_C SetActorLocation 100 200 300 - Set the location of the player

Note that the Blueprint function name is case sensitive, depending on how it is defined in the Blueprint editor.

7. Runtime reflection

vreflect exposes selected Unreal reflection operations through the UnrealCV command channel.

vreflect [obj_name] functions: List reflected functions on an object as JSON.
vreflect [obj_name] properties: List reflected properties on an object as JSON.
vreflect [obj_name] get [property_path]: Read a property by name or dotted path and return its type and value as JSON.
vreflect [obj_name] set [property_path] [value]: Set a property using Unreal text import syntax and return the updated value.
vreflect [obj_name] call_json [function_name] [json_args]: Call a reflected function with a JSON object keyed by parameter name and return output parameters as JSON.

Prefix the target with class: or cdo: to address a class default object. Examples:

vreflect BP_Player_C_0 get RootComponent.RelativeLocation
vreflect BP_Player_C_0 set RootComponent.RelativeLocation "(X=100,Y=200,Z=300)"
vreflect class:KismetMathLibrary call_json Add_IntInt {"A":2,"B":3}

Only expose UnrealCV to trusted clients. Reflection can read and mutate runtime state and invoke reflected functions.

8. Complete registered command index

The following generated index is synchronized with every production BindCommand registration. It supplements the hand-written explanations above and is the authoritative list for the current branch.

This index lists every command registered by the current C++ server. The hand-written sections above remain the place for examples, compatibility notes, and longer explanations.

Action

vget /action/game/is_paused: Get the pause status Source: Source/UnrealCV/Private/Commands/ActionHandler.cpp:26
vset /action/eyes_distance [float]: Set the distance of binocular stereo camera Source: Source/UnrealCV/Private/Commands/ActionHandler.cpp:46
vset /action/game/level [str]: Open level Source: Source/UnrealCV/Private/Commands/ActionHandler.cpp:34
vset /action/game/pause: Pause the game Source: Source/UnrealCV/Private/Commands/ActionHandler.cpp:20
vset /action/game/resume: Resume the game Source: Source/UnrealCV/Private/Commands/ActionHandler.cpp:24
vset /action/input/disable: Disable input Source: Source/UnrealCV/Private/Commands/ActionHandler.cpp:42
vset /action/input/enable: Enable input Source: Source/UnrealCV/Private/Commands/ActionHandler.cpp:38
vset /action/keyboard [str] [float]: Send a keyboard action to the game Source: Source/UnrealCV/Private/Commands/ActionHandler.cpp:51

Aliases and engine commands

vbp [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:71
vbp [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:72
vbp [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:73
vbp [str] [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:74
vbp [str] [str] [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:75
vbp [str] [str] [str] [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:76
vbp [str] [str] [str] [str] [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:77
vbp [str] [str] [str] [str] [str] [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:78
vbp [str] [str] [str] [str] [str] [str] [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:79
vbp [str] [str] [str] [str] [str] [str] [str] [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:80
vexec [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:63
vexec [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:64
vexec [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:65
vexec [str] [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:66
vexec [str] [str] [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:67
vexec [str] [str] [str] [str] [str] [str] [str]: Run UE5 blueprint function Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:68
vrun [str]: Run UE5 built-in commands Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:53
vrun [str] [str]: Run UE5 built-in commands Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:54
vrun [str] [str] [str]: Run UE5 built-in commands Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:55
vrun [str] [str] [str] [str]: Run UE5 built-in commands Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:56
vrun [str] [str] [str] [str] [str]: Run UE5 built-in commands Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:57
vrun [str] [str] [str] [str] [str] [str]: Run UE5 built-in commands Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:58

Camera

vget /camera/[uint]/depth [str]: Get npy binary data from depth sensor Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:942
vget /camera/[uint]/depth_shared: Get depth image through Windows shared memory Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:953
vget /camera/[uint]/fov: Get FOV Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:991
vget /camera/[uint]/lit [str]: Get png binary data from lit sensor Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:938
vget /camera/[uint]/lit_shared: Get lit image through Windows shared memory Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:950
vget /camera/[uint]/location: Get sensor location in world space Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:917
vget /camera/[uint]/normal [str]: Get npy binary data from surface normal sensor Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:946
vget /camera/[uint]/normal_shared: Get normal image through Windows shared memory Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:956
vget /camera/[uint]/object_mask [str]: Get object mask from camera sensor Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:969
vget /camera/[uint]/object_mask_shared: Get object mask through Windows shared memory Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:976
vget /camera/[uint]/optical_flow [str]: Get npy binary data from optical flow sensor Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:965
vget /camera/[uint]/rotation: Get sensor rotation in world space Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:930
vget /camera/[uint]/seg [str]: Get object mask from camera sensor Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:973
vget /camera/[uint]/seg_shared: Get segmentation through Windows shared memory Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:979
vget /camera/[uint]/size: Get Camera Film Size Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1001
vset /camera/[uint]/auto_brightness [float] [float]: Set camera auto-exposure min max brightness Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1037
vset /camera/[uint]/auto_speed [float] [float]: Set camera auto-exposure speed down and speed up Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1033
vset /camera/[uint]/exposure_bias [float]: Set camera exposure bias Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1029
vset /camera/[uint]/exposure_method [str]: Set camera exposure method Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1025
vset /camera/[uint]/focal [float] [float]: Set camera focus distance and range Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1050
vset /camera/[uint]/fov [float]: Set FOV Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:994
vset /camera/[uint]/illumination [str]: Set camera global illumination method: None, Lumen, ScreenSpace, Plugin, Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1021
vset /camera/[uint]/lit_source [str]: Set the capture source of the lit camera Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1013
vset /camera/[uint]/location [float] [float] [float]: Set sensor to location [x, y, z] Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:921
vset /camera/[uint]/motion_blur [float] [float] [float] [uint]: Set camera motion blur amount, max, per object, fps Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1046
vset /camera/[uint]/moveto [float] [float] [float]: Move camera to location [x, y, z], will be blocked by objects Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:926
vset /camera/[uint]/ortho_width [float]: Set ortho width of the camera Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1005
vset /camera/[uint]/physical_exposure [uint]: Set camera apply physical camera exposure Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1041
vset /camera/[uint]/projection_type [str]: Set camera projection type Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1009
vset /camera/[uint]/reflection [str]: Set camera reflection method: None, Lumen, ScreenSpace Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:1017
vset /camera/[uint]/rotation [float] [float] [float]: Set rotation [pitch, yaw, roll] of camera [id] Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:934
vset /camera/[uint]/size [uint] [uint]: Set Camera Film Size Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:997

Camera collection

vget /cameras: List all sensors in the scene Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:909
vset /cameras/spawn: Spawn a new camera actor in the scene Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:913

Level

vget /level/name: Get current level name Source: Source/UnrealCV/Private/Commands/PluginHandler.cpp:129

Miscellaneous

vcmd [str]: Run UE5 built-in commands Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:52
vreflect [str] [str]: Reflect functions and properties, or invoke a function with JSON arguments Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:84
vreflect [str] [str] [str]: Reflect functions and properties, or invoke a function with JSON arguments Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:85
vreflect [str] [str] [str] [str]: Reflect functions and properties, or invoke a function with JSON arguments Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:86
vreflect [str] [str] [str] [str] [str]: Reflect functions and properties, or invoke a function with JSON arguments Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:87
vreflect [str] [str] [str] [str] [str] [str]: Reflect functions and properties, or invoke a function with JSON arguments Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:88
vreflect [str] [str] [str] [str] [str] [str] [str]: Reflect functions and properties, or invoke a function with JSON arguments Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:89
vreflect [str] [str] [str] [str] [str] [str] [str] [str]: Reflect functions and properties, or invoke a function with JSON arguments Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:90
vreflect [str] [str] [str] [str] [str] [str] [str] [str] [str]: Reflect functions and properties, or invoke a function with JSON arguments Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:91
vreflect [str] [str] [str] [str] [str] [str] [str] [str] [str] [str]: Reflect functions and properties, or invoke a function with JSON arguments Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:92
vreflect [str] [str] [str] [str] [str] [str] [str] [str] [str] [str] [str]: Reflect functions and properties, or invoke a function with JSON arguments Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:93
vreflect [str] [str] [str] [str] [str] [str] [str] [str] [str] [str] [str] [str]: Reflect functions and properties, or invoke a function with JSON arguments Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:95

Object

vget /object/[str]/bones: Get all bone transforms in component space as JSON. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:240
vget /object/[str]/bones [str]: Get comma-separated bones, or all bones in component|world space, as JSON. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:244
vget /object/[str]/bones [str] [str]: Get comma-separated bones in component|world space as JSON. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:248
vget /object/[str]/bounds: Return the bounds in the world coordinate, formate is [minx, y, z, maxx, y, z] Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:236
vget /object/[str]/color: Get the labeling color of an object (used in object instance mask) Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:180
vget /object/[str]/label: Get actor label Availability: editor builds only. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:210
vget /object/[str]/location: Get object location [x, y, z] Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:160
vget /object/[str]/material: Get the material(s) of the object Availability: editor builds only. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:219
vget /object/[str]/mobility: Is the object static or movable? Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:188
vget /object/[str]/rotation: Get object rotation [pitch, yaw, roll] Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:168
vget /object/[str]/scale: Get object rotation [x, y, z] Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:228
vget /object/[str]/uclass_name: Get the UClass name for filtering objects Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:201
vget /object/[str]/vertex_location: Get vertex location Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:176
vset /object/[str]/color [uint] [uint] [uint]: Set the labeling color of an object [r, g, b] Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:184
vset /object/[str]/destroy: Destroy object Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:198
vset /object/[str]/hide: Hide object Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:195
vset /object/[str]/label [str]: Set actor label Availability: editor builds only. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:214
vset /object/[str]/location [float] [float] [float]: Set object location [x, y, z] Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:164
vset /object/[str]/material [uint] [str]: Set material of the object (via slot index) Availability: editor builds only. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:223
vset /object/[str]/name [str]: Set the name of the object Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:205
vset /object/[str]/rotation [float] [float] [float]: Set object rotation [pitch, yaw, roll] Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:172
vset /object/[str]/scale [float] [float] [float]: Set object scale [x, y, z] Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:232
vset /object/[str]/show: Show object Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:192

Object collection

vget /objects: Get the name of all objects Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:124
vset /objects/spawn [str]: Spawn an object with UClassName as the argument. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:144
vset /objects/spawn [str] [float] [float] [float]: Spawn an object at world location [x, y, z]. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:152
vset /objects/spawn [str] [str]: Spawn an object with UClassName as the argument. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:148
vset /objects/spawn [str] [str] [float] [float] [float]: Spawn a named object at world location [x, y, z]. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:156
vset /objects/spawn_cube: Spawn a box in the scene for debugging purpose. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:128
vset /objects/spawn_cube [float] [float] [float]: Spawn a box at world location [x, y, z]. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:136
vset /objects/spawn_cube [str]: Spawn a box in the scene for debugging purpose, with optional argument name. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:132
vset /objects/spawn_cube [str] [float] [float] [float]: Spawn a named box at world location [x, y, z]. Source: Source/UnrealCV/Private/Commands/ObjectHandler.cpp:140

Persistent level

vget /persistent_level/id: Get persistent level id, so that we can call BP function defined in it Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:97
vget /persistent_level/level_script_actor/id: Get persistent level id, so that we can call BP function defined in it Source: Source/UnrealCV/Private/Commands/AliasHandler.cpp:101

Scene

vget /scene/name: Get the name of this scene, to make sure the annotation data is for this scene. Source: Source/UnrealCV/Private/Commands/PluginHandler.cpp:127

Screenshot

vget /screenshot [str]: Get screenshot Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:905

Plugin

vget /unrealcv/commands: List registered UnrealCV command templates, one command per line Source: Source/UnrealCV/Private/Commands/PluginHandler.cpp:115
vget /unrealcv/echo [str]: [debug] Echo back all message, for debug Source: Source/UnrealCV/Private/Commands/PluginHandler.cpp:119
vget /unrealcv/help: List all available commands and their help message Source: Source/UnrealCV/Private/Commands/PluginHandler.cpp:111
vget /unrealcv/status: Get the status of UnrealCV plugin Source: Source/UnrealCV/Private/Commands/PluginHandler.cpp:107
vget /unrealcv/version: Get the version of UnrealCV, the format is v0.*.* Source: Source/UnrealCV/Private/Commands/PluginHandler.cpp:123

View mode

vget /viewmode: Get current ViewMode Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:987
vset /viewmode [str]: Set ViewMode to (lit, normal, depth, object_mask) Source: Source/UnrealCV/Private/Commands/CameraHandler.cpp:983