editor_toolset.toolsets.actor.ActorTools¶
Provides tools for inspecting and modifying actors, including their transforms, labels, parent-child relationships, and components.
17 tool(s).
editor_toolset.toolsets.actor.ActorTools.add_component¶
Adds a component to an actor instance or blueprint.
Args:
owner: The actor blueprint, instance, or SceneComponent to add to.
component_type: The type of component to add.
name: The name of the new component.
Returns:
The newly added actor component.
Input schema
{
"properties": {
"component_type": {
"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"
},
"name": {
"type": "string"
},
"owner": {
"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": [
"owner",
"component_type",
"name"
],
"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/Engine.ActorComponent",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.add_tag¶
Adds a tag to an actor.
Args:
actor: The actor to modify.
tag: The tag to add.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
},
"tag": {
"type": "string"
}
},
"required": [
"actor",
"tag"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.get_actor_bounds¶
Returns the bounding box of an actor.
Args:
actor: The actor to query.
Returns:
The world space bounding box for the actor.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
}
},
"required": [
"actor"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"isValid": {
"type": "boolean"
},
"max": {
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"min": {
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"required": [
"min",
"max",
"isValid"
],
"title": "Box",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.get_actor_transform¶
Returns the position, rotation, and scale of an actor.
Args:
actor: The actor to query.
Returns:
The world space actor transform.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
}
},
"required": [
"actor"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a 3D transformation with optional location, rotation, and scale.\nUnset fields mean \"identity\" when creating objects and \"don't change\" when modifying existing ones.",
"properties": {
"location": {
"description": "The world-space location.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"rotation": {
"description": "The world-space rotation.",
"properties": {
"pitch": {
"description": "Pitch (degrees) around Y axis",
"type": "number"
},
"roll": {
"description": "Roll (degrees) around X axis",
"type": "number"
},
"yaw": {
"description": "Yaw (degrees) around Z axis",
"type": "number"
}
},
"required": [
"pitch",
"yaw",
"roll"
],
"title": "Rotator",
"type": "object"
},
"scale": {
"description": "The scale.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"title": "ToolsetTransform",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.get_component_actor¶
Returns the actor that owns the specified component.
Args:
component: The component to query.
Returns:
The actor that owns this component.
Input schema
{
"properties": {
"component": {
"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/Engine.ActorComponent",
"type": "object"
}
},
"required": [
"component"
],
"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/Engine.Actor",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.get_components¶
Returns the components that an actor contains.
Args:
actor: The actor to query.
component_type: If set, will only return components of this type.
Returns:
The components in the actor.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
},
"component_type": {
"default": null,
"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": [
"actor"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.ActorComponent",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.get_label¶
Returns the actor's human friendly name as it appears in the editor.
Args:
actor: The actor to query.
Returns:
The label for the actor.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
}
},
"required": [
"actor"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.get_parent_component¶
Returns the parent component that this component is attached to, if any.
Args:
component: The scene component to query.
Returns:
The parent SceneComponent if attached to one, otherwise None.
Input schema
{
"properties": {
"component": {
"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/Engine.SceneComponent",
"type": "object"
}
},
"required": [
"component"
],
"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/Engine.SceneComponent",
"type": "object"
}
},
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.get_root_component¶
Returns the root component of an actor, if any.
Args:
actor: The actor to query.
Returns:
The actor's root SceneComponent, or None if it has no root component.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
}
},
"required": [
"actor"
],
"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/Engine.SceneComponent",
"type": "object"
}
},
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.get_tags¶
Returns the list of tags on an actor.
Args:
actor: The actor to query.
Returns:
The tags on the actor as strings.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
}
},
"required": [
"actor"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.has_tag¶
Returns whether an actor has a specific tag.
Args:
actor: The actor to query.
tag: The tag to check for.
Returns:
True if the actor has the tag, False otherwise.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
},
"tag": {
"type": "string"
}
},
"required": [
"actor",
"tag"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.look_at¶
Rotates an actor so its forward vector points at a world-space position.
Args:
actor: The actor to rotate.
target: The world-space position to face.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
},
"target": {
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"required": [
"actor",
"target"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.remove_component¶
Removes a component from an actor instance or blueprint.
Args:
component: The component to remove.
Returns:
True if the component was successfully removed.
Input schema
{
"properties": {
"component": {
"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/Engine.ActorComponent",
"type": "object"
}
},
"required": [
"component"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.remove_tag¶
Removes a tag from an actor.
Args:
actor: The actor to modify.
tag: The tag to remove.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
},
"tag": {
"type": "string"
}
},
"required": [
"actor",
"tag"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.set_actor_transform¶
Updates the position, rotation, and/or scale of an actor.
Args:
actor: The actor to modify.
xform: The new transform to apply to this actor.
worldspace: True means xform is in worldpace. False means relative to parent.
Has no effect on actors in blueprints, which only have a default
relative transform.
Returns:
True if an id matching the actor was found and it's position was set.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
},
"worldspace": {
"default": true,
"type": "boolean"
},
"xform": {
"description": "Represents a 3D transformation with optional location, rotation, and scale.\nUnset fields mean \"identity\" when creating objects and \"don't change\" when modifying existing ones.",
"properties": {
"location": {
"description": "The world-space location.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"rotation": {
"description": "The world-space rotation.",
"properties": {
"pitch": {
"description": "Pitch (degrees) around Y axis",
"type": "number"
},
"roll": {
"description": "Roll (degrees) around X axis",
"type": "number"
},
"yaw": {
"description": "Yaw (degrees) around Z axis",
"type": "number"
}
},
"required": [
"pitch",
"yaw",
"roll"
],
"title": "Rotator",
"type": "object"
},
"scale": {
"description": "The scale.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"title": "ToolsetTransform",
"type": "object"
}
},
"required": [
"actor",
"xform"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.set_label¶
Sets the human-friendly name of the actor.
Args:
actor: The actor to modify.
label: The new name for the actor.
Returns:
True if the label was updated correctly.
Input schema
{
"properties": {
"actor": {
"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/Engine.Actor",
"type": "object"
},
"label": {
"type": "string"
}
},
"required": [
"actor",
"label"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.actor.ActorTools.set_parent_component¶
Sets the parent for the specified scene component.
For blueprint actors, passing a component as the parent of the root promotes it
to the scene root, making the current root a child of it. If the current root is a
DefaultSceneRoot, Unreal will automatically remove it.
Args:
component: The scene component to modify.
parent: The new parent component. None will detach the component from its current parent.
Returns:
True if the reparent succeeded.
Input schema
{
"properties": {
"component": {
"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/Engine.SceneComponent",
"type": "object"
},
"parent": {
"default": null,
"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/Engine.SceneComponent",
"type": "object"
}
},
"required": [
"component"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}