Outdated documentation
This documentation page refers to Godot
4.3,
and may be outdated or incorrect.
Additionally, this engine version is
no longer supported.
Check this page in the stable branch for the latest additions and corrections.
SkinReference
Inherits: RefCounted < Object
A reference-counted holder object for a skeleton RID used in the RenderingServer.
Description
An internal object containing a mapping from a Skin used within the context of a particular MeshInstance3D to refer to the skeleton's RID in the RenderingServer.
See also MeshInstance3D.get_skin_reference and RenderingServer.instance_attach_skeleton.
Note that despite the similar naming, the skeleton RID used in the RenderingServer does not have a direct one-to-one correspondence to a Skeleton3D node.
In particular, a Skeleton3D node with no MeshInstance3D children may be unknown to the RenderingServer.
On the other hand, a Skeleton3D with multiple MeshInstance3D nodes which each have different MeshInstance3D.skin objects may have multiple SkinReference instances (and hence, multiple skeleton RIDs).
Methods
get_skeleton() const |
|
get_skin() const |
Method Descriptions
Returns the RID owned by this SkinReference, as returned by RenderingServer.skeleton_create.
Returns the Skin connected to this SkinReference. In the case of MeshInstance3D with no MeshInstance3D.skin assigned, this will reference an internal default Skin owned by that MeshInstance3D.
Note that a single Skin may have more than one SkinReference in the case that it is shared by meshes across multiple Skeleton3D nodes.