editor_toolset.toolsets.scene.SceneTools¶
Provides tools for working with the currently loaded level, including loading levels, placing and removing actors, controlling the level camera, and organizing actors in the outliner.
20 tool(s).
editor_toolset.toolsets.scene.SceneTools.add_to_scene_from_asset¶
Creates a new actor in the scene from an asset.
Args:
asset_path: The path to the asset to spawn (e.g. '/Game/Blueprints/MyActor').
name: The name of the actor instance.
xform: The transform for the new actor. Parent-local when `parent` is set;
world-space otherwise.
parent: If set, the new actor will be a child of this actor. If unset the Actor will
be a child of the world.
snap_to_ground: If set to true, will attempt to adjust the actors Z position so that
the bottom of its bounding box is on the ground.
Returns:
The created actor or nothing if creation was unsuccessful.
Input schema
{
"properties": {
"asset_path": {
"type": "string"
},
"name": {
"type": "string"
},
"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.Actor",
"type": "object"
},
"snap_to_ground": {
"default": false,
"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": [
"asset_path",
"name",
"xform"
],
"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.scene.SceneTools.add_to_scene_from_class¶
Creates a new instance of the specified object at the specified transform.
Args:
actor_type: The Actor class to instantiate.
name: The name of the actor instance.
xform: The transform for the new actor. Parent-local when `parent` is set;
world-space otherwise.
parent: If set, the new actor will be a child of this actor. If unset the Actor will
be a child of the world.
snap_to_ground: If set to true, will attempt to adjust the actors Z position so that
the bottom of its bounding box is on the ground.
Returns:
The created actor or nothing if creation was unsuccessful.
Input schema
{
"properties": {
"actor_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"
},
"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.Actor",
"type": "object"
},
"snap_to_ground": {
"default": false,
"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_type",
"name",
"xform"
],
"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.scene.SceneTools.can_edit¶
Checks whether an actor can be edited.
Args:
actor: The actor to check.
Returns:
True if the actor can be edited, False if it is checked out
or locked by another user in source control.
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": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.commit_level_instance¶
Saves or discards edits to a level instance and exits edit mode.
Args:
level_instance: The level instance actor to commit.
discard: If True, discards all changes without saving. Defaults to False.
Input schema
{
"properties": {
"discard": {
"default": false,
"type": "boolean"
},
"level_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/Engine.LevelInstance",
"type": "object"
}
},
"required": [
"level_instance"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.create_level_instance¶
Creates a Level Instance actor in the scene referencing an existing level asset.
Args:
level_path: The content path to the level asset (e.g. '/Game/Maps/MyLevel').
name: The label for the new Level Instance actor.
xform: The transform for the new actor.
parent: If set, the new actor will be a child of this actor.
Returns:
The created LevelInstance actor.
Input schema
{
"properties": {
"level_path": {
"type": "string"
},
"name": {
"type": "string"
},
"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.Actor",
"type": "object"
},
"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": [
"level_path",
"name",
"xform"
],
"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.LevelInstance",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.delete_folder¶
Deletes a folder from the outliner.
Actors directly in the folder are moved to the parent folder. Sub-folders and
their actors are preserved by re-rooting them under the parent. For example,
deleting 'Lighting' with a sub-folder 'Lighting/Spotlights' leaves 'Spotlights'
intact under the parent.
Args:
folder_path: The folder path to delete (e.g. 'Lighting/Spotlights').
Returns:
The number of actors that were moved.
Input schema
{
"properties": {
"folder_path": {
"type": "string"
}
},
"required": [
"folder_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "integer"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.edit_level_instance¶
Opens a level instance for editing.
While in edit mode, scene tools such as add_to_scene_from_class and
remove_from_scene operate within the level instance's sub-level. Only one
level instance can be in edit mode at a time. Call commit_level_instance
when done to save or discard changes.
Args:
level_instance: The level instance actor to open for editing.
Input schema
{
"properties": {
"level_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/Engine.LevelInstance",
"type": "object"
}
},
"required": [
"level_instance"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.find_actors¶
Searches the scene for actors that match specific criteria.
Args:
root: If set, will only search this actor and its children.
name: If set, will only return actors whose label contains this string
(case-insensitive).
actor_type: If set, will only return actors that are of this type.
tag: If set, will only return actors that have this tag.
bounds: If set, only returns actors whose bounds overlap this world-space AABB.
collision_channels: If set, bounds checks will uses a native physics overlap query
restricted to these channels. Non-collision actors will be ignored.
Returns:
A list of actors that match the criteria.
Input schema
{
"properties": {
"actor_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"
},
"bounds": {
"default": null,
"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"
},
"collision_channels": {
"items": {
"enum": [
"ObjectTypeQuery1",
"ObjectTypeQuery2",
"ObjectTypeQuery3",
"ObjectTypeQuery4",
"ObjectTypeQuery5",
"ObjectTypeQuery6",
"ObjectTypeQuery7",
"ObjectTypeQuery8",
"ObjectTypeQuery9",
"ObjectTypeQuery10",
"ObjectTypeQuery11",
"ObjectTypeQuery12",
"ObjectTypeQuery13",
"ObjectTypeQuery14",
"ObjectTypeQuery15",
"ObjectTypeQuery16",
"ObjectTypeQuery17",
"ObjectTypeQuery18",
"ObjectTypeQuery19",
"ObjectTypeQuery20",
"ObjectTypeQuery21",
"ObjectTypeQuery22",
"ObjectTypeQuery23",
"ObjectTypeQuery24",
"ObjectTypeQuery25",
"ObjectTypeQuery26",
"ObjectTypeQuery27",
"ObjectTypeQuery28",
"ObjectTypeQuery29",
"ObjectTypeQuery30",
"ObjectTypeQuery31",
"ObjectTypeQuery32",
"ObjectTypeQuery33",
"ObjectTypeQuery34",
"ObjectTypeQuery35",
"ObjectTypeQuery36",
"ObjectTypeQuery37",
"ObjectTypeQuery38",
"ObjectTypeQuery39",
"ObjectTypeQuery40",
"ObjectTypeQuery41",
"ObjectTypeQuery42",
"ObjectTypeQuery43",
"ObjectTypeQuery44",
"ObjectTypeQuery45",
"ObjectTypeQuery46",
"ObjectTypeQuery47",
"ObjectTypeQuery48",
"ObjectTypeQuery49",
"ObjectTypeQuery50",
"ObjectTypeQuery51",
"ObjectTypeQuery52",
"ObjectTypeQuery53",
"ObjectTypeQuery54",
"ObjectTypeQuery55",
"ObjectTypeQuery56",
"ObjectTypeQuery57",
"ObjectTypeQuery58",
"ObjectTypeQuery59",
"ObjectTypeQuery60",
"ObjectTypeQuery61",
"ObjectTypeQuery62",
"ObjectTypeQuery63",
"ObjectTypeQuery64"
],
"title": "EObjectTypeQuery",
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"root": {
"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.Actor",
"type": "object"
},
"tag": {
"type": "string"
}
},
"required": [
"name",
"tag",
"collision_channels"
],
"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.Actor",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.get_actors_in_folder¶
Returns the actors in the specified outliner folder.
Args:
folder_path: The folder path to query (e.g. 'Lighting/Spotlights').
recursive: If True, also includes actors in sub-folders.
Returns:
A list of actors in the specified folder.
Input schema
{
"properties": {
"folder_path": {
"type": "string"
},
"recursive": {
"default": false,
"type": "boolean"
}
},
"required": [
"folder_path"
],
"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.Actor",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.get_collision_channels¶
Returns all available collision channels for use with find_actors.
Returns:
A list of all collision channels.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"enum": [
"ObjectTypeQuery1",
"ObjectTypeQuery2",
"ObjectTypeQuery3",
"ObjectTypeQuery4",
"ObjectTypeQuery5",
"ObjectTypeQuery6",
"ObjectTypeQuery7",
"ObjectTypeQuery8",
"ObjectTypeQuery9",
"ObjectTypeQuery10",
"ObjectTypeQuery11",
"ObjectTypeQuery12",
"ObjectTypeQuery13",
"ObjectTypeQuery14",
"ObjectTypeQuery15",
"ObjectTypeQuery16",
"ObjectTypeQuery17",
"ObjectTypeQuery18",
"ObjectTypeQuery19",
"ObjectTypeQuery20",
"ObjectTypeQuery21",
"ObjectTypeQuery22",
"ObjectTypeQuery23",
"ObjectTypeQuery24",
"ObjectTypeQuery25",
"ObjectTypeQuery26",
"ObjectTypeQuery27",
"ObjectTypeQuery28",
"ObjectTypeQuery29",
"ObjectTypeQuery30",
"ObjectTypeQuery31",
"ObjectTypeQuery32",
"ObjectTypeQuery33",
"ObjectTypeQuery34",
"ObjectTypeQuery35",
"ObjectTypeQuery36",
"ObjectTypeQuery37",
"ObjectTypeQuery38",
"ObjectTypeQuery39",
"ObjectTypeQuery40",
"ObjectTypeQuery41",
"ObjectTypeQuery42",
"ObjectTypeQuery43",
"ObjectTypeQuery44",
"ObjectTypeQuery45",
"ObjectTypeQuery46",
"ObjectTypeQuery47",
"ObjectTypeQuery48",
"ObjectTypeQuery49",
"ObjectTypeQuery50",
"ObjectTypeQuery51",
"ObjectTypeQuery52",
"ObjectTypeQuery53",
"ObjectTypeQuery54",
"ObjectTypeQuery55",
"ObjectTypeQuery56",
"ObjectTypeQuery57",
"ObjectTypeQuery58",
"ObjectTypeQuery59",
"ObjectTypeQuery60",
"ObjectTypeQuery61",
"ObjectTypeQuery62",
"ObjectTypeQuery63",
"ObjectTypeQuery64"
],
"title": "EObjectTypeQuery",
"type": "string"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.get_current_level¶
Returns the path to the current level asset.
Returns:
The name of the loaded level, if any.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.get_folders¶
Returns all folder paths currently in use in the outliner.
Includes all intermediate parent paths. For example, if an actor is assigned to
'Lighting/Spotlights', both 'Lighting' and 'Lighting/Spotlights' are returned.
Returns:
A sorted list of unique folder path strings.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.is_checked_out¶
Checks whether an actor is checked out by the current user.
Args:
actor: The actor to check.
Returns:
True if the actor is currently checked out by the current user.
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": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.load_level¶
Loads a level in the editor.
Args:
level_path: The path to the level asset.
Input schema
{
"properties": {
"level_path": {
"type": "string"
}
},
"required": [
"level_path"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.merge_actors¶
Merges multiple StaticMesh actors into a single mesh asset and actor.
Args:
actors: The StaticMeshActors to merge. All must be in the same level.
output_path: Content path for the merged mesh asset (e.g. '/Game/Meshes/Merged').
name: Label for the new merged actor. Defaults to the last segment of output_path.
destroy_source_actors: If True, removes the source actors after merging.
Returns:
The merged StaticMeshActor.
Input schema
{
"properties": {
"actors": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.StaticMeshActor",
"type": "object"
},
"type": "array"
},
"destroy_source_actors": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
},
"output_path": {
"type": "string"
}
},
"required": [
"actors",
"output_path",
"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.StaticMeshActor",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.remove_from_scene¶
Deletes an actor from the scene.
Args:
actor: The actor to remove.
Returns:
True if the actor was removed.
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": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.rename_folder¶
Renames a folder in the outliner.
Updates the folder path for all actors in the folder and any sub-folders.
For example, renaming 'Lighting' to 'Lights' also updates actors in
'Lighting/Spotlights' to 'Lights/Spotlights'. If the new path already
exists then the affected actors will be merged into it.
Args:
old_path: The current folder path (e.g. 'Lighting').
new_path: The new folder path (e.g. 'Lights').
Returns:
The number of actors whose folder path was updated.
Input schema
{
"properties": {
"new_path": {
"type": "string"
},
"old_path": {
"type": "string"
}
},
"required": [
"old_path",
"new_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "integer"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.save_actor¶
Saves the actor to disk.
Args:
actor: The actor to save.
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"
}
editor_toolset.toolsets.scene.SceneTools.set_actor_folder¶
Assigns an actor to the specified folder in the outliner.
Creates the folder implicitly if it does not already exist. Pass an empty string
to move the actor to the root of the outliner.
Args:
actor: The actor to move.
folder_path: The folder path to assign (e.g. 'Lighting/Spotlights').
Pass an empty string to move the actor to the root.
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"
},
"folder_path": {
"type": "string"
}
},
"required": [
"actor",
"folder_path"
],
"type": "object"
}
editor_toolset.toolsets.scene.SceneTools.trace_world¶
Traces a line through the world and returns the distance to the first hit.
Args:
start: The start point of the trace in world space.
end: The end point of the trace in world space.
Returns:
The distance from start to the hit point, or None if nothing was hit.
Input schema
{
"properties": {
"end": {
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"start": {
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"required": [
"start",
"end"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "number"
}
},
"type": "object"
}