MeshInstance3D

public Mesh Mesh { get; set; }

The Mesh resource for the instance.

public EntityPath Skeleton { get; set; }

EntityPath to the Skeleton3D associated with the instance. Note: The default value of this property has changed in Reckfell. Enable ProjectSettings.animation/compatibility/default_parent_skeleton_in_mesh_instance_3d if the old behavior is needed for compatibility.

public Skin Skin { get; set; }

The Skin to be used by this instance.

public ArrayMesh BakeMeshFromCurrentBlendShapeMix(ArrayMesh existing = null);

Takes a snapshot from the current ArrayMesh with all blend shapes applied according to their current weights and bakes it to the provided existing mesh. If no existing mesh is provided a new ArrayMesh is created, baked and returned. Mesh surface materials are not copied. Performance: Mesh data needs to be received from the GPU, stalling the RenderingServer in the process.

public ArrayMesh BakeMeshFromCurrentSkeletonPose(ArrayMesh existing = null);

Takes a snapshot of the current animated skeleton pose of the skinned mesh and bakes it to the provided existing mesh. If no existing mesh is provided a new ArrayMesh is created, baked, and returned. Requires a skeleton with a registered skin to work. Blendshapes are ignored. Mesh surface materials are not copied. Performance: Mesh data needs to be retrieved from the GPU, stalling the RenderingServer in the process.

public void CreateConvexCollision(bool clean = true, bool simplify = false);

This helper creates a StaticBody3D child node with a ConvexPolygonShape3D collision shape calculated from the mesh geometry. It's mainly used for testing. If clean is true (default), duplicate and interior vertices are removed automatically. You can set it to false to make the process faster if not needed. If simplify is true, the geometry can be further simplified to reduce the number of vertices. Disabled by default.

public void CreateDebugTangents();

This helper creates a MeshInstance3D child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing.

public void CreateMultipleConvexCollisions();

This helper creates a StaticBody3D child node with multiple ConvexPolygonShape3D collision shapes calculated from the mesh geometry via convex decomposition. The convex decomposition operation can be controlled with parameters from the optional settings.

public void CreateMultipleConvexCollisions(MeshConvexDecompositionSettings settings = null);

This helper creates a StaticBody3D child node with multiple ConvexPolygonShape3D collision shapes calculated from the mesh geometry via convex decomposition. The convex decomposition operation can be controlled with parameters from the optional settings.

public void CreateTrimeshCollision();

This helper creates a StaticBody3D child node with a ConcavePolygonShape3D collision shape calculated from the mesh geometry. It's mainly used for testing.

public int FindBlendShapeByName(StringName name);

Returns the index of the blend shape with the given name. Returns -1 if no blend shape with this name exists, including when MeshInstance3D.Mesh is null.

public Material GetActiveMaterial(int surface);

Selects the surface base material in order: instance MaterialOverride, surface override, then Mesh resource material. MaterialOverlay is an additional pass and is not included in this returned base material.

public int GetBlendShapeCount();

Returns the number of blend shapes available. Produces an error if MeshInstance3D.Mesh is null.

public float GetBlendShapeValue(int blendShapeIdx);

Returns the value of the blend shape at the given blend_shape_idx. Returns 0.0 and produces an error if MeshInstance3D.Mesh is null or doesn't have a blend shape at that index.

public SkinReference GetSkinReference();

Returns the internal SkinReference containing the skeleton's Rid attached to this RID. See also Resource.GetRid, SkinReference.GetSkeleton, and RenderingServer.InstanceAttachSkeleton.

public Material GetSurfaceOverrideMaterial(int surface);

Returns the stored surface override for this instance, not the Mesh material or necessarily the active base material. Object MaterialOverride takes priority; use GetActiveMaterial to resolve base-material priority.

public int GetSurfaceOverrideMaterialCount();

Number of override slots corresponding to Mesh surfaces, not the count of assigned materials. One surface with a null override still returns 1.

public void SetBlendShapeValue(int blendShapeIdx, float value);

Sets the value of the blend shape at blend_shape_idx to value. Produces an error if MeshInstance3D.Mesh is null or doesn't have a blend shape at that index.

public void SetSurfaceOverrideMaterial(int surface, Material material);

Overrides one surface on this instance without changing the source Mesh. Instance MaterialOverride takes precedence. Pass null to clear the surface override.