editor_toolset.toolsets.primitive.PrimitiveTools¶
Provides tools for adding primitive geometry components to actors.
4 tool(s).
editor_toolset.toolsets.primitive.PrimitiveTools.add_cone¶
Adds a cone-shaped StaticMeshComponent to an actor.
Args:
actor: The actor to add the component to.
name: The name of the new component.
radius: The radius of the cone base.
height: The height of the cone.
local_transform: The transform of the component relative to the actor.
Returns:
The new StaticMeshComponent.
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"
},
"height": {
"default": 100,
"type": "number"
},
"local_transform": {
"default": null,
"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"
},
"name": {
"type": "string"
},
"radius": {
"default": 50,
"type": "number"
}
},
"required": [
"actor",
"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.StaticMeshComponent",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.primitive.PrimitiveTools.add_cube¶
Adds a cube-shaped StaticMeshComponent to an actor.
Args:
actor: The actor to add the component to.
name: The name of the new component.
dimensions: The x, y, and z size of the cube.
local_transform: The transform of the component relative to the actor.
Returns:
The new StaticMeshComponent.
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"
},
"dimensions": {
"default": {
"x": 100,
"y": 100,
"z": 100
},
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"local_transform": {
"default": null,
"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"
},
"name": {
"type": "string"
}
},
"required": [
"actor",
"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.StaticMeshComponent",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.primitive.PrimitiveTools.add_cylinder¶
Adds a cylinder-shaped StaticMeshComponent to an actor.
Args:
actor: The actor to add the component to.
name: The name of the new component.
radius: The radius of the cylinder.
height: The height of the cylinder.
local_transform: The transform of the component relative to the actor.
Returns:
The new StaticMeshComponent.
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"
},
"height": {
"default": 100,
"type": "number"
},
"local_transform": {
"default": null,
"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"
},
"name": {
"type": "string"
},
"radius": {
"default": 50,
"type": "number"
}
},
"required": [
"actor",
"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.StaticMeshComponent",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.primitive.PrimitiveTools.add_sphere¶
Adds a sphere-shaped StaticMeshComponent to an actor.
Args:
actor: The actor to add the component to.
name: The name of the new component.
radius: The radius of the sphere.
local_transform: The transform of the component relative to the actor.
Returns:
The new StaticMeshComponent.
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"
},
"local_transform": {
"default": null,
"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"
},
"name": {
"type": "string"
},
"radius": {
"default": 50,
"type": "number"
}
},
"required": [
"actor",
"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.StaticMeshComponent",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}