SpringBoneCollision3D

Documentation

Overview

A collision can be a child of SpringBoneSimulator3D. If it is not a child of SpringBoneSimulator3D, it has no effect.

The colliding and sliding are done in the SpringBoneSimulator3D's modification process in order of its collision list which is set by SpringBoneSimulator3D.SetCollisionPath. If SpringBoneSimulator3D.AreAllChildCollisionsEnabled is true, the order matches SceneTree.

If Bone is set, it synchronizes with the bone pose of the ancestor Skeleton3D, which is done in before the SpringBoneSimulator3D's modification process as the pre-process.

Warning: A scaled SpringBoneCollision3D will likely not behave as expected. Make sure that the parent Skeleton3D and its bones are not scaled.

Index

• type Advanced
• type Any
• type Extension
  • func (self *Extension[T]) AsNode() Node.Instance
  • func (self *Extension[T]) AsNode3D() Node3D.Instance
  • func (self *Extension[T]) AsObject() [1]gd.Object
  • func (self *Extension[T]) AsSpringBoneCollision3D() Instance
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func New() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsSpringBoneCollision3D() Instance
  • func (self Instance) Bone() int
  • func (self Instance) BoneName() string
  • func (self Instance) GetSkeleton() Skeleton3D.Instance
  • func (self Instance) ID() ID
  • func (self Instance) PositionOffset() Vector3.XYZ
  • func (self Instance) RotationOffset() Quaternion.IJKX
  • func (self Instance) SetBone(value int)
  • func (self Instance) SetBoneName(value string)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) SetPositionOffset(value Vector3.XYZ)
  • func (self Instance) SetRotationOffset(value Quaternion.IJKX)
  • 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
	AsSpringBoneCollision3D() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsNode3D

func (self *Extension[T]) AsNode3D() Node3D.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsSpringBoneCollision3D

func (self *Extension[T]) AsSpringBoneCollision3D() Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.SpringBoneCollision3D

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 New

func New() 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) AsSpringBoneCollision3D

func (self Instance) AsSpringBoneCollision3D() Instance

func (Instance) Bone

func (self Instance) Bone() int

The index of the attached bone.

func (Instance) BoneName

func (self Instance) BoneName() string

The name of the attached bone.

func (Instance) GetSkeleton

func (self Instance) GetSkeleton() Skeleton3D.Instance

Get parent Skeleton3D node of the parent SpringBoneSimulator3D if found.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) PositionOffset

func (self Instance) PositionOffset() Vector3.XYZ

The offset of the position from Skeleton3D's Bone pose position.

func (Instance) RotationOffset

func (self Instance) RotationOffset() Quaternion.IJKX

The offset of the rotation from Skeleton3D's Bone pose rotation.

func (Instance) SetBone

func (self Instance) SetBone(value int)

SetBone sets the property returned by [GetBone].

func (Instance) SetBoneName

func (self Instance) SetBoneName(value string)

SetBoneName sets the property returned by [GetBoneName].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetPositionOffset

func (self Instance) SetPositionOffset(value Vector3.XYZ)

SetPositionOffset sets the property returned by [GetPositionOffset].

func (Instance) SetRotationOffset

func (self Instance) SetRotationOffset(value Quaternion.IJKX)

SetRotationOffset sets the property returned by [GetRotationOffset].

func (Instance) Virtual

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