The following document presents all the endpoints callable via Data Hub on a running Engine instance. All changes are applied immediately. However, changes to some properties of the World Settings in Live mode might result in a restart of Pixotope modules and a brief reduction in performance.
To learn about more advanced usage of these endpoints jump to: Advanced RPC Usage.
Object Setting
Calls allowing for scene manipulation.
SetProperty
SetProperty
Set a property value for a given actor.
Apart from basic types, supports properties in structs, arrays and asset names.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
PropertyPath
STRING ARRAYSTRING
Dot-separated path to the targeted property, or an array of such paths.
Hover over the star left of your property in the Engine to learn the desired value.
Value
STRINGSTRING ARRAYANY
The value to be applied. Strings are parsed into proper formats, but raw numbers should be (for the most part) supported too.
If provided with an array will try to match to the array of PropertyPaths.
Supports struct imports in both a format of JSON or the Unreal's text import format.
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
ApplyClamp
BOOLOPTIONAL
Should we apply clamp values defined in property's metadata.
Default: false
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
PropertyPath
STRING ARRAYSTRING
Dot-separated path to the targeted property, or an array of such paths.
Hover over the star left of your property in the Engine to learn the desired value.
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
Example - Reset the graphics color grading gamma. (Set in a SetProperty example.)
CallResult (you can receive, if subscribed)Topic: {
"Type": "CallResult",
"Target": "TJCGWS040-TestClient",
"ExecutedOn": "TJCGWS040-Engine",
"Method": "ResetProperty",
"ID": "000"
}
Message: {"Result":[{}]}
CallFunction
CallFunction
Call a method on a given object. This is the main and recommended way of handling live input and controls.
Params
ObjectSearch
STRING ARRAYSTRING
FunctionName
STRING
FunctionArguments
STRING ARRAYOPTIONAL
SetVisibility
SetVisibility
Set actor's / component's visibility.
Params
ObjectSearch
STRING ARRAYSTRING
BroadcastUpdate
BOOLOPTIONAL
Visibility
BOOL
ResetVisibility
ResetVisibility
Reset actor's / component's visibility.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
Actors only!
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
SetMobility
SetMobility
Set actor's / component's mobility.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
Actors only!
Mobility
ENUM
Allowed values: NO_TRANSFORM, STATIC, STATIONARY, or MOVABLE
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
ResetMobility
ResetMobility
Reset actor's / component's mobility.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
Actors only!
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
SetTransform
SetTransform
Set actor's or component's relative transform.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
Transform
FLOAT ARRAYOPTIONAL
Consecutively: LocX, LocY, LocZ, RotX, RotY, RotZ, SclX, SclY, SclZ.
Invalid or missing values will be ignored.
Can be an array longer than 9 to apply different transforms when targetting multiple objects.
Location
FLOAT ARRAYOPTIONAL
Consecutively: LocX, LocY, LocZ.
Invalid or missing values will be ignored.
Rotation
FLOAT ARRAYOPTIONAL
Consecutively: RotX, RotY, RotZ.
Invalid or missing values will be ignored.
Scale
FLOAT ARRAYOPTIONAL
Consecutively: SclX, SclY, SclZ.
Invalid or missing values will be ignored.
IgnorePattern
BOOL ARRAYOPTIONAL
Allows to ignore certain values from being applied.
Consecutively: LocX, LocY, LocZ, RotX, RotY, RotZ, SclX, SclY, SclZ.
Can be an array longer than 9 to apply different ignore patterns when targetting multiple objects.
Default: all false
IsDelta
BOOLOPTIONAL
Should given transform values be added to the exiting transform. Default: false
IsLocalTranslation
BOOLOPTIONAL
If IsDelta, should we add location along local axis. Default: false
IsLocalRotation
BOOLOPTIONAL
If IsDelta, should we add rotation along local axis. Default: true
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
ResetTransform
ResetTransform
Reset object's transform.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
Should Engine send an Update message for changed values?
Default: true
SetRenderLayer
SetRenderLayer
Set actor's or component's render layer.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
ResetObject
ResetObject
Reset all object's adjustments.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
ShouldResetComponents
BOOLOPTIONAL
Default: true
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
Object Spawning
A group of calls allowing for spawning and deleting actors and components from the scene.
SpawnActor
SpawnActor
Spawn a new actor.
Params
ActorType
STRING
BroadcastUpdate
BOOLOPTIONAL
SpawnComponent
SpawnComponent
Add a component to an actor.
Params
ObjectSearch
STRING ARRAYSTRING
ComponentType
STRING
BroadcastUpdate
BOOLOPTIONAL
DeleteSpawnedObject
DeleteSpawnedObject
Delete an existing actor. Works only for the actors previously spawned through the API.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
API-spawned Actors only!
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
DeleteAllSpawnedActors
DeleteAllSpawnedActors
Delete all spawned actors.
Params
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
RenameSpawnedActor
RenameSpawnedActor
Rename a previously spawned actor.
Params
ObjectSearch
STRING ARRAYSTRING
NewName
STRING
BroadcastUpdate
BOOLOPTIONAL
SetActorParent
SetActorParent
Set one actor to be another's parent.
No params.
Object Getting
Calls allowing for getting the information about the scene.
GetProperty
GetProperty
Send JSON describing a property to Data Hub.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
PropertyPath
STRING ARRAYSTRING
Dot-separated path to the targeted property, or an array of such paths.
Hover over the star left of your property in the Engine to learn the desired value.
RecursionDepth
INTOPTIONAL
Default: 1
ForceExposeChildren
BOOLOPTIONAL
Default: true
PairObjectSearchesAndPropertyPaths
BOOLOPTIONAL
Default: false
GetFunction
GetFunction
Send JSON describing a function to Data Hub.
Params
ObjectSearch
STRING ARRAYSTRING
FunctionName
STRING
GetTransform
GetTransform
Send JSON describing actor's or component's relative transform to Data Hub.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
GetObject
GetObject
Send JSON describing an object to Data Hub.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
RecursionDepth
OPTIONAL
Default: 1
ForceExposeProperties
OPTIONAL
Default: false
ForceExposeFunctions
OPTIONAL
Default: false
GetWorld
GetWorld
Send JSON describing the currently active world to Data Hub.
Calls allowing fine-tune what is send from the scene in response to get calls.
ExposeProperty
ExposeProperty
Exposes a property to be visible as when calling GetObject.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
PropertyPath
STRING ARRAYSTRING
Dot-separated path to the targeted property, or an array of such paths.
Hover over the star left of your property in the Engine to learn the desired value.
ShouldExposePerObject
BOOLOPTIONAL
Default: false
ShouldExposePerClass
BOOLOPTIONAL
Default: false
IsPropertyExposed
IsPropertyExposed
Informs if a property is visible to GetObject call and how it is exposed.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
PropertyPath
STRING ARRAYSTRING
Dot-separated path to the targeted property, or an array of such paths.
Hover over the star left of your property in the Engine to learn the desired value.
GetAllExposedProperties
GetAllExposedProperties
This will return only per class and per object user exposed properties. The c++ exposed ones will not show up.
Returns all properties explicitly exposed to API.
Params
IncludePropertyDetails
BOOLOPTIONAL
Default: false
RecursionDepth
INTOPTIONAL
Default: 1
ForceExposeChildren
BOOLOPTIONAL
Default: true
ExposeFunction
ExposeFunction
Exposes a fuction per class to be visible as when calling GetObject.
Params
FunctionName
STRING
ObjectType
OPTIONALSTRING
ObjectSearch
OPTIONALSTRING
ShouldExposePerClass
BOOL
IsFunctionExposed
IsFunctionExposed
Informs if a function is visible to GetObject calls.
Params
FunctionName
STRING
ObjectType
OPTIONALSTRING
ObjectSearch
OPTIONALSTRING
GetAllExposedFunctions
GetAllExposedFunctions
Returns all functions explicitly exposed to API.
No params.
World Settings
Calls allowing for manipulating World Settings.
ResetSettings
ResetSettings
This call is scheduled for deprecation. Please use ResetProperty with an array of PropertyPaths instead.
Reset pixotope settings group.
Params
SettingsGroup
STRING
Legacy grouping of settings. Please use a different call.
GetSettings
GetSettings
This call is scheduled for deprecation. Please use GetProperty instead with an array of PropertyPaths instead.
Send current values of a settings group to Data Hub.
Params
SettingsGroup
STRING
Legacy grouping of settings. Please use a different call.
ShouldIncludeDetails
BOOLOPTIONAL
Default: true
Adjustments
Calls exposed by the Pixotope Engine's adjustment system.
GetPropertyAdjustmentStatus
GetPropertyAdjustmentStatus
Check if a particular property was modified.
Possible AdjustmentStatus values: UNKNOWN, DEFAULT, MODIFIED, SPAWNED, EDITOR.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
PropertyPath
STRING ARRAYSTRING
Dot-separated path to the targeted property, or an array of such paths.
Hover over the star left of your property in the Engine to learn the desired value.
GetVisibilityAdjustmentStatus
GetVisibilityAdjustmentStatus
Check if a particular object's visibility was modified.
Possible AdjustmentStatus values: UNKNOWN, DEFAULT, MODIFIED, SPAWNED, EDITOR.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
GetMobilityAdjustmentStatus
GetMobilityAdjustmentStatus
Check if a particular object's mobility was modified.
Possible AdjustmentStatus values: UNKNOWN, DEFAULT, MODIFIED, SPAWNED, EDITOR.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
GetTransformAdjustmentStatus
GetTransformAdjustmentStatus
Check if a particular object's transform was modified.
Possible AdjustmentStatus values: UNKNOWN, DEFAULT, MODIFIED, SPAWNED, EDITOR.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
GetRenderLayerAdjustmentStatus
GetRenderLayerAdjustmentStatus
Check if a particular object's render layer was modified.
Possible AdjustmentStatus values: UNKNOWN, DEFAULT, MODIFIED, SPAWNED, EDITOR.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
GetObjectAdjustmentStatus
GetObjectAdjustmentStatus
Check if a particular object was modified.
Possible AdjustmentStatus values: UNKNOWN, DEFAULT, MODIFIED, SPAWNED, EDITOR.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
WasObjectSpawned
WasObjectSpawned
Check if a particular object was spawned with API.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
WasAnyObjectSpawned
WasAnyObjectSpawned
Check if any object was spawned.
No params.
WasAnythingModifed
WasAnythingModifed
Check if any objects, parameters or settings were modified in this world.
No params.
ResetAllAdjustments
ResetAllAdjustments
Reset all adjustments applied to this world.
Params
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
BakeAllAdjustments
BakeAllAdjustments
Bakes all adjustments permanently into the world. Works in the editor mode only.
No params.
Cinematic
PlaySequence
PlaySequence
Play a given level sequence.
Params
AssetPath
STRING
Path of the sequence asset to play.
AdditionalLoops
INTEGEROPTIONAL
Number of additional loops to play. Set to -1 to loop infinitely. Default: 0
StopSequence
StopSequence
Stop a given level sequence.
Params
AssetPath
STRING
Path of the sequence asset to stop.
GetAvailableSequences
GetAvailableSequences
Returns a list of asset paths for available sequences.
No params.
Other
GetVersion
GetVersion
Returns Pixotope and Unreal Engine versions.
No params.
ExecuteConsoleCommand
ExecuteConsoleCommand
Execute a command in the engine console.
Params
Command
STRING
An engine console command to execute.
BroadcastUpdate
BOOLOPTIONAL
Should Engine send an Update message for changed values?
Default: true
GetCompositingMode
GetCompositingMode
Send the compositing mode of current world. Possible return values: Internal, External
No params.
OpenLevel
OpenLevel
Load a new level without closing the project.
Params
LevelPath
STRING
Example: Levels/TestMap0
ReopenLevel
ReopenLevel
Reload the current level without closing the project.
No params.
Kill
Kill
Closes the engine straight away.
No params.
GetAutolayout
GetAutolayout
Feature under development.
Send a list of function descriptions that were marked for auto-layouting.
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
GetSpecialObjectMappings
GetSpecialObjectMappings
Get all the object names mapped to a certain object search tag.
Params
ObjectSearchTag
STRING
Pixotope object search tag. For example: post_process_handler.
GetAllSpecialObjectMappings
GetAllSpecialObjectMappings
Get all the object search tags with object names mapped to them.
No params.
BroadcastWorldUpdate
BroadcastWorldUpdate
Force a broadcast for a particular property.
Params
UpdateType
STRING
Only PropertyChanged supported for now.
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
PropertyPath
STRING ARRAYSTRING
Dot-separated path to the targeted property, or an array of such paths.
Hover over the star left of your property in the Engine to learn the desired value.
SaveEditor
SaveEditor
Trigger saving dirty editor packages.
No params.
Undo
Undo
Undo the latest editor change. Works only in edit mode.
No params.
Redo
Redo
Redo the latest undone editor change. Works only in edit mode.
No params.
HighlightObject
HighlightObject
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
UnhighlightObject
UnhighlightObject
Params
ObjectSearch
STRING ARRAYSTRING
Unique name of the target Actor, or Actor.Component, or a special_tag, or an array of multiple object searches.
Hover over the star left of your property in the Engine to learn the desired value.
UnhighlightAllObjects
UnhighlightAllObjects
No params.
Focus
Focus
No params.
Minimize
Minimize
No params.
Refocus
Refocus
No params.
GetCurrentTimecode
GetCurrentTimecode
This call is scheduled for deprecation. Please subscribe to SystemInfo update instead.
Returns the current timecode if datahub is in synchronized mode.
Calling this with a NoSync param set to true is recommended, to avoid the message being delayed.
No params.
Advanced RPC Usage
Object Search
Many commands take
ObjectSearch
as their first argument. It allows to target world's actors, components, and some other special objects with the commands. Typically, in order to target actors, one can just type a unique name of this actor. To find out the unique name of an actor, move the mouse over the label of the actor in
World Outliner
in the Editor, and the unique name will be shown in the tooltip.
ObjectSearch
also accepts certain predefined names for targeting special objects:
compositing_mesh
light_component
light_actor
compositing_plane
material_handler
post_process_handler
camera_root
tracked_camera
world_settings
level_blueprint
bpe_manager
Otherwise the object search will by default look for the first actor in the scene of the given name.
Alternatively, it is possible to access the following advanced search modes:
. (component search, by adding a dot after actors nameand following it with the component name, ex. SomeActor0.SomeComponent42)
all_of_type (followed by a type name will target all actors of a given type currently existing in the scene)
first_of_type (followed by a type name will target the first actor of a given type currently existing in the scene)
default_object (followed by a type name will target the default object of that type)
Property Path
PropertyPath
parameter, required by many calls, is used to target certain properties(fields) on objects. For properties existing directly in particular object's class the property path will be just this properties' name. However for children of struct properties path will consist of consecutive property names separated with a dot. For example:
Parameters.Position.X
(targeting float X in Position vector in Parameters struct).
Ignore Property Value
In case that we are sending SetProperty or SetSettings we might sometimes want our call to be ignored for particular properties. To achieve that pass
:::ignore:::
string as a value.
Call Responses
Every executed call responds with a CallResult message that holds either relevant data or an error message.
Call Result
Every successful call result coming from the Engine holds a JSON array field (called Result). It is an array because almost any executed Call can be scaled to target muliple objects.
Error
If a call fails, the call result message holds an Error field instead of Result. This field can inform on what was the reason for the failure.
Update
Certain calls can optionally broadcast meaningful Update messages throughout the network. It can be useful for keeping otherwise uninvolved client software up to date with what's happening in the engine.
Adding Adjustments
Pixotope Engine has a feature allowing all the remote changes done in Live or Live Preview to be saved and later applied on start again. In order to add your Call as an adjustment add to it a param named IsAdjustment, set to true.
Filtering Results
Often a call will return too much data, and that might take too long parsing or be just unpleasant to work with. In order to filter only the fields you are interested in from your CallResult add a param named ResultFilter, with a array of json fields you want to be sent. Dot-separated paths to particular fields are supported. For example: ResultFilter=["Object.Components.Name"] would result in only component names being sent on GetObject.
Avoiding Frame Drops
Add an optional param ParamSplitBetweenFrames to your call to configure on which array param should we try to split between and execute every element separately in order to avoid dropping frames. This will efectively treat every element of that array param together with other params as a separate API call, but it will combine the results into a single result message.
Avoiding Synchronization Delays
It is possible to bypass synchronization (and the resulting delay) for select Calls by adding a param NoSync set to true.
JavaScript errors detected
Please note, these errors can depend on your browser setup.
If this problem persists, please contact our support.