editor.rc

Remote Control passthrough to any BlueprintCallable function or BlueprintVisible property on any UObject

← API Reference

editor.rc.call

Invoke any BlueprintCallable function on any UObject via RemoteControl's ResolveCall/InvokeCall pipeline.

Parameters:

Name Type Required Description
objectPathstringYesFull path to the target UObject
functionNamestringYesName of the BlueprintCallable function to invoke
parametersobjectNoKey-value pairs matching the function's input parameters
generateTransactionbooleanNoIf true, wraps the call in an undo transaction (default: false)

Returns:

Name Type Description
successbooleanAlways true on success
objectPathstringThe resolved object path
functionNamestringThe function that was called
returnValuestringThe return value exported as text (if function has a return type)
outParamsobjectAny output parameters as key-value string pairs (if function has out params)

Example Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "editor.rc.call",
  "params": {
    "objectPath": "/Game/Maps/MyLevel.MyLevel:PersistentLevel.StaticMeshActor_0.StaticMeshComponent0",
    "functionName": "SetVisibility",
    "parameters": {
      "bNewVisibility": true,
      "bPropagateToChildren": true
    },
    "generateTransaction": true
  }
}

Example Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "success": true,
    "objectPath": "/Game/Maps/MyLevel.MyLevel:PersistentLevel.StaticMeshActor_0.StaticMeshComponent0",
    "functionName": "SetVisibility"
  }
}

editor.rc.property

Read or write any BlueprintVisible property on any UObject. Omit value to read; include value to write.

Parameters:

Name Type Required Description
objectPathstringYesFull path to the target UObject
propertyNamestringYesName of the property to read or write
valueanyNoValue to set. Omit to read. Strings are parsed via ImportText; numbers and booleans are converted.
generateTransactionbooleanNoIf true, wraps the write in an undo transaction (default: false)

Returns (read):

Name Type Description
successbooleanAlways true on success
objectPathstringThe resolved object path
propertyNamestringThe property that was read
valuestringThe property value exported as text
propertyTypestringThe C++ type of the property
actionstring"read"

Returns (write):

Name Type Description
successbooleanAlways true on success
objectPathstringThe resolved object path
propertyNamestringThe property that was written
actionstring"write"

Example Request (read):

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "editor.rc.property",
  "params": {
    "objectPath": "/Game/Maps/MyLevel.MyLevel:PersistentLevel.PointLight_0.PointLightComponent0",
    "propertyName": "Intensity"
  }
}

Example Response (read):

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "success": true,
    "objectPath": "/Game/Maps/MyLevel.MyLevel:PersistentLevel.PointLight_0.PointLightComponent0",
    "propertyName": "Intensity",
    "value": "5000.000000",
    "propertyType": "float",
    "action": "read"
  }
}

Example Request (write):

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "editor.rc.property",
  "params": {
    "objectPath": "/Game/Maps/MyLevel.MyLevel:PersistentLevel.PointLight_0.PointLightComponent0",
    "propertyName": "Intensity",
    "value": "10000.0",
    "generateTransaction": true
  }
}

Example Response (write):

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "success": true,
    "objectPath": "/Game/Maps/MyLevel.MyLevel:PersistentLevel.PointLight_0.PointLightComponent0",
    "propertyName": "Intensity",
    "action": "write"
  }
}

editor.rc.describe

Get metadata about a UObject -- its class, all BlueprintCallable functions, and all BlueprintVisible properties.

Parameters:

Name Type Required Description
objectPathstringYesFull path to the UObject to describe

Returns:

Name Type Description
objectPathstringResolved full path of the object
classNamestringClass name (e.g. PointLightComponent)
classPathstringFull class path
functionsarrayArray of BlueprintCallable function descriptors
functionCountnumberNumber of BC functions
propertiesarrayArray of BlueprintVisible property descriptors
propertyCountnumberNumber of visible properties

Function descriptor fields:

Name Type Description
namestringFunction name
flagsarrayFunction flags (Const, Static, Pure, Net)
parametersarrayInput parameters (name, type, isOut, isOptional)
returnTypestringReturn type or "void"

Property descriptor fields:

Name Type Description
namestringProperty name
typestringC++ type
readOnlybooleanTrue if BlueprintReadOnly
editAnywherebooleanTrue if EditAnywhere
categorystringCategory metadata (if set)

Example Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "editor.rc.describe",
  "params": {
    "objectPath": "/Game/Maps/MyLevel.MyLevel:PersistentLevel.PointLight_0.PointLightComponent0"
  }
}

Example Response (abbreviated):

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "objectPath": "/Game/Maps/MyLevel.MyLevel:...",
    "className": "PointLightComponent",
    "classPath": "/Script/Engine.PointLightComponent",
    "functions": [
      {
        "name": "SetIntensity",
        "flags": [],
        "parameters": [
          {"name": "NewIntensity", "type": "float", "isOut": false, "isOptional": false}
        ],
        "returnType": "void"
      }
    ],
    "functionCount": 42,
    "properties": [
      {
        "name": "Intensity",
        "type": "float",
        "readOnly": false,
        "editAnywhere": true,
        "category": "Light"
      }
    ],
    "propertyCount": 15
  }
}