Documentation
¶
Overview ¶
An internal object containing a mapping from a Skin used within the context of a particular MeshInstance3D to refer to the skeleton's Resource.ID in the RenderingServer.
See also MeshInstance3D.GetSkinReference and RenderingServer.InstanceAttachSkeleton.
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 Resource.IDs).
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 RenderingServer.SkeletonCreate.
func (Instance) GetSkin ¶
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.
Source Files