Mesh, primitives & PCG¶
Static/skeletal mesh inspection & editing, primitive components, and Procedural Content Generation graphs.
5 toolset(s), 73 tool(s). Full schemas in the raw catalog.
editor_toolset.toolsets.static_mesh.StaticMeshTools · raw schemas¶
Provides tools for inspecting and modifying static mesh assets.
| Tool | Summary |
|---|---|
editor_toolset.toolsets.static_mesh.StaticMeshTools.generate_convex_collisions |
Generates convex hull collision shapes for a static mesh. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.generate_lods |
Auto-generates LODs for a static mesh using triangle reduction. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.get_bounds |
Returns the local-space bounding box of a static mesh. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.get_lod_count |
Returns the number of LODs in a static mesh asset. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.get_lod_thresholds |
Returns the screen-size thresholds at which each LOD becomes active. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.get_material |
Returns the material assigned to a named slot on a static mesh. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.get_material_slots |
Returns the names of all material slots in a static mesh. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.get_triangle_count |
Returns the number of triangles in a specific LOD of a static mesh. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.get_vertex_count |
Returns the number of vertices in a specific LOD of a static mesh. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.import_file |
Imports a mesh file from disk as a StaticMesh asset. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.is_nanite_enabled |
Returns whether Nanite is enabled for a static mesh. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.remove_collisions |
Removes all collision shapes from a static mesh. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.remove_lods |
Removes all auto-generated LODs from a static mesh, keeping only LOD 0. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.set_lod_thresholds |
Sets the screen-size thresholds at which each LOD becomes active. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.set_material |
Assigns a material to a named slot on a static mesh asset. |
editor_toolset.toolsets.static_mesh.StaticMeshTools.set_nanite_enabled |
Enables or disables Nanite for a static mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools · raw schemas¶
Provides tools for inspecting and modifying skeletal mesh assets, including
| Tool | Summary |
|---|---|
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.add_socket |
Adds a named socket to a skeletal mesh attached to a bone. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.assign_physics_asset |
Assigns a physics asset to a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_bone_children |
Returns the direct children of a bone. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_bone_names |
Returns the names of all bones in a skeletal mesh in hierarchy order. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_bone_parent |
Returns the name of a bone's parent, or an empty string for the root bone. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_bounds |
Returns the local-space bounding volume of a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_lod_count |
Returns the number of LODs in a skeletal mesh asset. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_material |
Returns the material assigned to a named slot on a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_material_slots |
Returns the names of all material slots in a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_morph_target_names |
Returns the names of all morph targets on a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_physics_asset |
Returns the physics asset assigned to a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_section_count |
Returns the number of sections in a specific LOD of a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_skeleton |
Returns the skeleton asset associated with a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_socket_bone |
Returns the name of the bone that a socket is attached to. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_socket_names |
Returns the names of all sockets on a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_socket_transform |
Returns the local transform of a socket relative to its parent bone. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.get_vertex_count |
Returns the number of vertices in a specific LOD of a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.import_file |
Imports a mesh file from disk as a SkeletalMesh asset. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.remove_socket |
Removes a named socket from a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.rename_socket |
Renames a socket on a skeletal mesh. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.set_material |
Assigns a material to a named slot on a skeletal mesh asset. |
editor_toolset.toolsets.skeletal_mesh.SkeletalMeshTools.set_socket_transform |
Sets the local transform of a socket relative to its parent bone. |
editor_toolset.toolsets.primitive.PrimitiveTools · raw schemas¶
Provides tools for adding primitive geometry components to actors.
| Tool | Summary |
|---|---|
editor_toolset.toolsets.primitive.PrimitiveTools.add_cone |
Adds a cone-shaped StaticMeshComponent to an actor. |
editor_toolset.toolsets.primitive.PrimitiveTools.add_cube |
Adds a cube-shaped StaticMeshComponent to an actor. |
editor_toolset.toolsets.primitive.PrimitiveTools.add_cylinder |
Adds a cylinder-shaped StaticMeshComponent to an actor. |
editor_toolset.toolsets.primitive.PrimitiveTools.add_sphere |
Adds a sphere-shaped StaticMeshComponent to an actor. |
PCGToolset.PCGToolset · raw schemas¶
Toolset for building and modifying PCG graphs
| Tool | Summary |
|---|---|
PCGToolset.PCGToolset.AddCommentBox |
Adds a comment box around the given nodes. |
PCGToolset.PCGToolset.AddNode |
Adds a native node to the graph. |
PCGToolset.PCGToolset.AddSubgraphNode |
Adds a subgraph node to the graph. |
PCGToolset.PCGToolset.ConnectNodePins |
Add an edge between two nodes connected to the specified pins. |
PCGToolset.PCGToolset.CreateGraph |
Creates a new saved PCG graph asset. |
PCGToolset.PCGToolset.DisconnectNodePins |
Removes the edge between two nodes connected to the specified pins. |
PCGToolset.PCGToolset.DrawSpline |
Triggers the user to draw a spline in the viewport to be used later in the world building. Waits for the user to be done. |
PCGToolset.PCGToolset.ExecuteGraphInstance |
Executes the graph instance and returns any issues encountered during execution. |
PCGToolset.PCGToolset.GetGraphDescription |
Returns the description of a PCG graph. |
PCGToolset.PCGToolset.GetGraphInstanceParams |
Gets the graph instance params of a specific actor, actor MUST have a graph instance |
PCGToolset.PCGToolset.GetGraphSchema |
Returns the schema for a PCG Graph's graph parameters |
PCGToolset.PCGToolset.GetGraphStructure |
Returns the complete structure of a PCG graph including all nodes, |
PCGToolset.PCGToolset.GetNativeNodeSchema |
Returns the schema for a PCG node type including input/output pins, |
PCGToolset.PCGToolset.GetNodeDataView |
Returns a JSON Data View of a specific node's output data from the last graph execution. |
PCGToolset.PCGToolset.GetNodeInfo |
Returns node details including name, position, and all parameter values. |
PCGToolset.PCGToolset.ListAvailableSubgraphs |
Lists the PCG graphs that can be used with the Subgraph native node. Only these graphs should be used with |
PCGToolset.PCGToolset.ListGraphInstances |
Gets all actors with a PCG graph instance in the scene. |
PCGToolset.PCGToolset.ListNativeNodes |
Returns a list of available native PCG node type names. |
PCGToolset.PCGToolset.RemoveCommentBox |
Removes a comment box from the graph. Does not affect the nodes it contains. |
PCGToolset.PCGToolset.RemoveGraphParams |
Removes graph parameters to a specific PCG graph, such that they are not overridable anymore. |
PCGToolset.PCGToolset.RemoveNode |
Removes the node from the graph, will also remove edges connected to the node. |
PCGToolset.PCGToolset.RepositionNode |
Change the position of node. |
PCGToolset.PCGToolset.ResetGraphInstanceParams |
Resets the given graph instance params back to the graph's default values. Actor MUST have a graph instance. |
PCGToolset.PCGToolset.SetGraphDescription |
Set the description of a PCGGraph |
PCGToolset.PCGToolset.SetGraphInstanceParams |
Sets the graph instance params of a specific actor, actor MUST have a graph instance |
PCGToolset.PCGToolset.SetGraphParams |
Adds one or more graph user parameters to a specific PCG graph, such that they will be overridable in per graph instance. |
PCGToolset.PCGToolset.SetNodeComment |
Change the comment on the specified node. |
PCGToolset.PCGToolset.SpawnGraphInstance |
Spawns a PCG Volume with associated Graph Instance into the scene, optionally with Graph Param overrides. |
PCGToolset.PCGToolset.UpdateCommentBox |
Updates an existing comment box with new nodes and value. |
PCGToolset.PCGToolset.UpdateNode |
Updates a node by changing its params and/or title. |
PCGToolset.PCGSpatialToolset · raw schemas¶
PCGSpatial Toolset
| Tool | Summary |
|---|---|
PCGToolset.PCGSpatialToolset.RunPCGInstantGraph |
Runs an instant PCG graph with the specified parameters in fire-and-forget mode |