Documentation
¶
Overview ¶
An internal object containing a mapping from a graphics.gd/classdb/Skin used within the context of a particular graphics.gd/classdb/MeshInstance3D to refer to the skeleton's [Resource.ID] in the RenderingServer.
See also graphics.gd/classdb/MeshInstance3D.Instance.GetSkinReference and graphics.gd/classdb/RenderingServer.InstanceAttachSkeleton.
Note that despite the similar naming, the skeleton RID used in the graphics.gd/classdb/RenderingServer does not have a direct one-to-one correspondence to a graphics.gd/classdb/Skeleton3D node.
In particular, a graphics.gd/classdb/Skeleton3D node with no graphics.gd/classdb/MeshInstance3D children may be unknown to the graphics.gd/classdb/RenderingServer.
On the other hand, a graphics.gd/classdb/Skeleton3D with multiple graphics.gd/classdb/MeshInstance3D nodes which each have different graphics.gd/classdb/MeshInstance3D.Instance.Skin objects may have multiple SkinReference instances (and hence, multiple skeleton [Resource.ID]s).
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsSkinReference() Instance
- func (self Instance) GetSkeleton() RID.Skeleton
- func (self Instance) GetSkin() Skin.Instance
- func (self Instance) ID() ID
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsSkinReference ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.SkinReference
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsSkinReference ¶
func (Instance) GetSkeleton ¶
Returns the [Resource.ID] owned by this SkinReference, as returned by graphics.gd/classdb/RenderingServer.SkeletonCreate.
func (Instance) GetSkin ¶
Returns the graphics.gd/classdb/Skin connected to this SkinReference. In the case of graphics.gd/classdb/MeshInstance3D with no graphics.gd/classdb/MeshInstance3D.Instance.Skin assigned, this will reference an internal default graphics.gd/classdb/Skin owned by that graphics.gd/classdb/MeshInstance3D.
Note that a single graphics.gd/classdb/Skin may have more than one graphics.gd/classdb/SkinReference in the case that it is shared by meshes across multiple graphics.gd/classdb/Skeleton3D nodes.
Source Files