editor_toolset.toolsets.object.ObjectTools

Provides tools for inspecting and modifying the properties of Unreal Objects and Unreal Classes, including those in Blueprints. Also use this toolset to discover available classes and subclasses.

6 tool(s).

editor_toolset.toolsets.object.ObjectTools.get_class

Returns the class of an Unreal object.

    Args:
        instance: The object instance to query.

    Returns:
        The class of the object.

Input schema

{
  "properties": {
    "instance": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/CoreUObject.Object",
      "type": "object"
    }
  },
  "required": [
    "instance"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/CoreUObject.Class",
      "type": "object"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

editor_toolset.toolsets.object.ObjectTools.get_properties

Returns the values of one or more properties on an object.

    Args:
        instance: The the object to query.
        properties: The names of the properties to query.

    Returns:
        A JSON formatted string of the properties and their values.

Input schema

{
  "properties": {
    "instance": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/CoreUObject.Object",
      "type": "object"
    },
    "properties": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "instance",
    "properties"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

editor_toolset.toolsets.object.ObjectTools.list_properties

Returns a list of properties that are on the specified object.

    Args:
        instance: The object to query.

    Returns:
        A list of properties on the object.

Input schema

{
  "properties": {
    "instance": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/CoreUObject.Object",
      "type": "object"
    }
  },
  "required": [
    "instance"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

editor_toolset.toolsets.object.ObjectTools.reset_properties

Resets one or more properties on an object to their default values, removing any per-instance overrides.

    Args:
        instance: The object with the properties to reset.
        properties: The names of the properties to reset to their defaults.

    Returns:
        True if all properties were reset. False otherwise.

Input schema

{
  "properties": {
    "instance": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/CoreUObject.Object",
      "type": "object"
    },
    "properties": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "instance",
    "properties"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

editor_toolset.toolsets.object.ObjectTools.search_subclasses

Finds all subclasses of a given class.

    Args:
        base_class: The class to search subclasses of.
        class_name: Optional case-insensitive substring filter on the class path.

    Returns:
        A list of subclasses matching the filter.

Input schema

{
  "properties": {
    "base_class": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/CoreUObject.Class",
      "type": "object"
    },
    "class_name": {
      "type": "string"
    }
  },
  "required": [
    "base_class",
    "class_name"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "properties": {
          "refPath": {
            "description": "The reference stored as a soft path string.",
            "type": "string"
          }
        },
        "required": [
          "refPath"
        ],
        "title": "Class@/Script/CoreUObject.Object",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

editor_toolset.toolsets.object.ObjectTools.set_properties

Sets the values of properties on an object.

    Args:
        instance: The object with the property.
        values: A JSON formatted string of the properties to set and their values.
            For instanced sub-object properties, pass a class path as the instance member.

    Returns:
        True if the property was set. False otherwise.

Input schema

{
  "properties": {
    "instance": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/CoreUObject.Object",
      "type": "object"
    },
    "values": {
      "type": "string"
    }
  },
  "required": [
    "instance",
    "values"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}