SkeletonModifier3D

Documentation

Overview

Package SkeletonModifier3D provides methods for working with SkeletonModifier3D object instances.

Index

• type Advanced
• type Any
• type Implementation
• type Instance
  • func New() Instance
  • func (self Instance) Active() bool
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsSkeletonModifier3D() Instance
  • func (self Instance) GetSkeleton() [1]gdclass.Skeleton3D
  • func (self Instance) Influence() Float.X
  • func (self Instance) OnModificationProcessed(cb func())
  • func (self Instance) SetActive(value bool)
  • func (self Instance) SetInfluence(value Float.X)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type Interface

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
	AsSkeletonModifier3D() Instance
}

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.SkeletonModifier3D

[SkeletonModifier3D] retrieves a target [Skeleton3D] by having a [Skeleton3D] parent. If there is [AnimationMixer], modification always performs after playback process of the [AnimationMixer]. This node should be used to implement custom IK solvers, constraints, or skeleton physics.

See [Interface] for methods that can be overridden by a [Class] that extends it.

%!(EXTRA string=SkeletonModifier3D)

var Nil Instance

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

func New

func New() Instance

func (Instance) Active

func (self Instance) Active() bool

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) AsSkeletonModifier3D

func (self Instance) AsSkeletonModifier3D() Instance

func (Instance) GetSkeleton

func (self Instance) GetSkeleton() [1]gdclass.Skeleton3D

Get parent [Skeleton3D] node if found.

func (Instance) Influence

func (self Instance) Influence() Float.X

func (Instance) OnModificationProcessed

func (self Instance) OnModificationProcessed(cb func())

func (Instance) SetActive

func (self Instance) SetActive(value bool)

func (Instance) SetInfluence

func (self Instance) SetInfluence(value Float.X)

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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

type Interface

type Interface interface {
	//Override this virtual method to implement a custom skeleton modifier. You should do things like get the [Skeleton3D]'s current pose and apply the pose here.
	//[method _process_modification] must not apply [member influence] to bone poses because the [Skeleton3D] automatically applies influence to all bone poses set by the modifier.
	ProcessModification()
}