Documentation
¶
Overview ¶
This modification moves a series of bones, typically called a bone chain, towards a target. What makes this modification special is that it calculates the velocity and acceleration for each bone in the bone chain, and runs a very light physics-like calculation using the inputted values. This allows the bones to overshoot the target and "jiggle" around. It can be configured to act more like a spring, or sway around like cloth might.
This modification is useful for adding additional motion to things like hair, the edges of clothing, and more. It has several settings to that allow control over how the joint moves when the target moves.
Note: The Jiggle modifier has jiggle_joints, which are the data objects that hold the data for each joint in the Jiggle chain. This is different from than Bone2D nodes! Jiggle joints hold the data needed for each Bone2D in the bone chain used by the Jiggle modification.
Index ¶
- type Advanced
- type Any
- type Extension
- func (self *Extension[T]) AsObject() [1]gd.Object
- func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
- func (self *Extension[T]) AsResource() Resource.Instance
- func (self *Extension[T]) AsSkeletonModification2D() SkeletonModification2D.Instance
- func (self *Extension[T]) AsSkeletonModification2DJiggle() Instance
- type ID
- type Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AsSkeletonModification2D() SkeletonModification2D.Instance
- func (self Instance) AsSkeletonModification2DJiggle() Instance
- func (self Instance) Damping() Float.X
- func (self Instance) GetCollisionMask() int
- func (self Instance) GetJiggleJointBone2dNode(joint_idx int) string
- func (self Instance) GetJiggleJointBoneIndex(joint_idx int) int
- func (self Instance) GetJiggleJointDamping(joint_idx int) Float.X
- func (self Instance) GetJiggleJointGravity(joint_idx int) Vector2.XY
- func (self Instance) GetJiggleJointMass(joint_idx int) Float.X
- func (self Instance) GetJiggleJointOverride(joint_idx int) bool
- func (self Instance) GetJiggleJointStiffness(joint_idx int) Float.X
- func (self Instance) GetJiggleJointUseGravity(joint_idx int) bool
- func (self Instance) GetUseColliders() bool
- func (self Instance) Gravity() Vector2.XY
- func (self Instance) ID() ID
- func (self Instance) JiggleDataChainLength() int
- func (self Instance) Mass() Float.X
- func (self Instance) SetCollisionMask(collision_mask int)
- func (self Instance) SetDamping(value Float.X)
- func (self Instance) SetGravity(value Vector2.XY)
- func (self Instance) SetJiggleDataChainLength(value int)
- func (self Instance) SetJiggleJointBone2dNode(joint_idx int, bone2d_node string)
- func (self Instance) SetJiggleJointBoneIndex(joint_idx int, bone_idx int)
- func (self Instance) SetJiggleJointDamping(joint_idx int, damping Float.X)
- func (self Instance) SetJiggleJointGravity(joint_idx int, gravity Vector2.XY)
- func (self Instance) SetJiggleJointMass(joint_idx int, mass Float.X)
- func (self Instance) SetJiggleJointOverride(joint_idx int, override bool)
- func (self Instance) SetJiggleJointStiffness(joint_idx int, stiffness Float.X)
- func (self Instance) SetJiggleJointUseGravity(joint_idx int, use_gravity bool)
- func (self Instance) SetMass(value Float.X)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetStiffness(value Float.X)
- func (self Instance) SetTargetNodepath(value string)
- func (self Instance) SetUseColliders(use_colliders bool)
- func (self Instance) SetUseGravity(value bool)
- func (self Instance) Stiffness() Float.X
- func (self Instance) TargetNodepath() string
- func (self Instance) UseGravity() 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]) AsResource ¶
func (*Extension[T]) AsSkeletonModification2D ¶
func (self *Extension[T]) AsSkeletonModification2D() SkeletonModification2D.Instance
func (*Extension[T]) AsSkeletonModification2DJiggle ¶
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.SkeletonModification2DJiggle
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) AsResource ¶
func (Instance) AsSkeletonModification2D ¶
func (self Instance) AsSkeletonModification2D() SkeletonModification2D.Instance
func (Instance) AsSkeletonModification2DJiggle ¶
func (Instance) Damping ¶
The default amount of damping applied to the Jiggle joints, if they are not overridden. Higher values lead to more of the calculated velocity being applied.
func (Instance) GetCollisionMask ¶
Returns the collision mask used by the Jiggle modifier when collisions are enabled.
func (Instance) GetJiggleJointBone2dNode ¶
Returns the Bone2D node assigned to the Jiggle joint at 'joint_idx'.
func (Instance) GetJiggleJointBoneIndex ¶
Returns the index of the Bone2D node assigned to the Jiggle joint at 'joint_idx'.
func (Instance) GetJiggleJointDamping ¶
Returns the amount of damping of the Jiggle joint at 'joint_idx'.
func (Instance) GetJiggleJointGravity ¶
Returns a Vector2.XY representing the amount of gravity the Jiggle joint at 'joint_idx' is influenced by.
func (Instance) GetJiggleJointMass ¶
Returns the amount of mass of the jiggle joint at 'joint_idx'.
func (Instance) GetJiggleJointOverride ¶
Returns a boolean that indicates whether the joint at 'joint_idx' is overriding the default Jiggle joint data defined in the modification.
func (Instance) GetJiggleJointStiffness ¶
Returns the stiffness of the Jiggle joint at 'joint_idx'.
func (Instance) GetJiggleJointUseGravity ¶
Returns a boolean that indicates whether the joint at 'joint_idx' is using gravity or not.
func (Instance) GetUseColliders ¶
Returns whether the jiggle modifier is taking physics colliders into account when solving.
func (Instance) Gravity ¶
The default amount of gravity applied to the Jiggle joints, if they are not overridden.
func (Instance) JiggleDataChainLength ¶
The amount of Jiggle joints in the Jiggle modification.
func (Instance) Mass ¶
The default amount of mass assigned to the Jiggle joints, if they are not overridden. Higher values lead to faster movements and more overshooting.
func (Instance) SetCollisionMask ¶
Sets the collision mask that the Jiggle modifier will use when reacting to colliders, if the Jiggle modifier is set to take colliders into account.
func (Instance) SetDamping ¶
SetDamping sets the property returned by [GetDamping].
func (Instance) SetGravity ¶
SetGravity sets the property returned by [GetGravity].
func (Instance) SetJiggleDataChainLength ¶
SetJiggleDataChainLength sets the property returned by [GetJiggleDataChainLength].
func (Instance) SetJiggleJointBone2dNode ¶
Sets the Bone2D node assigned to the Jiggle joint at 'joint_idx'.
func (Instance) SetJiggleJointBoneIndex ¶
Sets the bone index, 'bone_idx', of the Jiggle joint at 'joint_idx'. When possible, this will also update the bone2d_node of the Jiggle joint based on data provided by the linked skeleton.
func (Instance) SetJiggleJointDamping ¶
Sets the amount of damping of the Jiggle joint at 'joint_idx'.
func (Instance) SetJiggleJointGravity ¶
Sets the gravity vector of the Jiggle joint at 'joint_idx'.
func (Instance) SetJiggleJointMass ¶
Sets the of mass of the Jiggle joint at 'joint_idx'.
func (Instance) SetJiggleJointOverride ¶
Sets whether the Jiggle joint at 'joint_idx' should override the default Jiggle joint settings. Setting this to true will make the joint use its own settings rather than the default ones attached to the modification.
func (Instance) SetJiggleJointStiffness ¶
Sets the of stiffness of the Jiggle joint at 'joint_idx'.
func (Instance) SetJiggleJointUseGravity ¶
Sets whether the Jiggle joint at 'joint_idx' should use gravity.
func (Instance) SetStiffness ¶
SetStiffness sets the property returned by [GetStiffness].
func (Instance) SetTargetNodepath ¶
SetTargetNodepath sets the property returned by [GetTargetNode].
func (Instance) SetUseColliders ¶
If true, the Jiggle modifier will take colliders into account, keeping them from entering into these collision objects.
func (Instance) SetUseGravity ¶
SetUseGravity sets the property returned by [GetUseGravity].
func (Instance) Stiffness ¶
The default amount of stiffness assigned to the Jiggle joints, if they are not overridden. Higher values act more like springs, quickly moving into the correct position.
func (Instance) TargetNodepath ¶
The NodePath to the node that is the target for the Jiggle modification. This node is what the Jiggle chain will attempt to rotate the bone chain to.
func (Instance) UseGravity ¶
Whether the gravity vector, Gravity, should be applied to the Jiggle joints, assuming they are not overriding the default settings.
Source Files