BoneAttachment3D

Documentation

Overview

Package BoneAttachment3D provides methods for working with BoneAttachment3D object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsBoneAttachment3D() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) BoneIdx() int
  • func (self Instance) BoneName() string
  • func (self Instance) GetExternalSkeleton() string
  • func (self Instance) GetUseExternalSkeleton() bool
  • func (self Instance) OnSkeletonUpdate()
  • func (self Instance) OverridePose() bool
  • func (self Instance) SetBoneIdx(value int)
  • func (self Instance) SetBoneName(value string)
  • func (self Instance) SetExternalSkeleton(external_skeleton string)
  • func (self Instance) SetOverridePose(value bool)
  • func (self Instance) SetUseExternalSkeleton(use_external_skeleton bool)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

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 Any

type Any interface {
	gd.IsClass
	AsBoneAttachment3D() Instance
}

type Instance

type Instance [1]gdclass.BoneAttachment3D

This node selects a bone in a [Skeleton3D] and attaches to it. This means that the [BoneAttachment3D] node will either dynamically copy or override the 3D transform of the selected bone.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsBoneAttachment3D

func (self Instance) AsBoneAttachment3D() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode3D

func (self Instance) AsNode3D() Node3D.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) BoneIdx

func (self Instance) BoneIdx() int

func (Instance) BoneName

func (self Instance) BoneName() string

func (Instance) GetExternalSkeleton

func (self Instance) GetExternalSkeleton() string

Returns the [NodePath] to the external [Skeleton3D] node, if one has been set.

func (Instance) GetUseExternalSkeleton

func (self Instance) GetUseExternalSkeleton() bool

Returns whether the BoneAttachment3D node is using an external [Skeleton3D] rather than attempting to use its parent node as the [Skeleton3D].

func (Instance) OnSkeletonUpdate

func (self Instance) OnSkeletonUpdate()

A function that is called automatically when the [Skeleton3D] is updated. This function is where the [BoneAttachment3D] node updates its position so it is correctly bound when it is [i]not[/i] set to override the bone pose.

func (Instance) OverridePose

func (self Instance) OverridePose() bool

func (Instance) SetBoneIdx

func (self Instance) SetBoneIdx(value int)

func (Instance) SetBoneName

func (self Instance) SetBoneName(value string)

func (Instance) SetExternalSkeleton

func (self Instance) SetExternalSkeleton(external_skeleton string)

Sets the [NodePath] to the external skeleton that the BoneAttachment3D node should use. See [method set_use_external_skeleton] to enable the external [Skeleton3D] node.

func (Instance) SetOverridePose

func (self Instance) SetOverridePose(value bool)

func (Instance) SetUseExternalSkeleton

func (self Instance) SetUseExternalSkeleton(use_external_skeleton bool)

Sets whether the BoneAttachment3D node will use an external [Skeleton3D] node rather than attempting to use its parent node as the [Skeleton3D]. When set to [code]true[/code], the BoneAttachment3D node will use the external [Skeleton3D] node set in [method set_external_skeleton].

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value