Documentation
¶
Overview ¶
Package SkeletonModification2DJiggle provides methods for working with SkeletonModification2DJiggle object instances.
Index ¶
- type Advanced
- type Any
- 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) 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) 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) UnsafePointer() unsafe.Pointer
- 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 Instance ¶
type Instance [1]gdclass.SkeletonModification2DJiggle
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. [b]Note:[/b] The Jiggle modifier has [code]jiggle_joints[/code], 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.
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) 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 [param joint_idx].
func (Instance) GetJiggleJointBoneIndex ¶
Returns the index of the [Bone2D] node assigned to the Jiggle joint at [param joint_idx].
func (Instance) GetJiggleJointDamping ¶
Returns the amount of damping of the Jiggle joint at [param joint_idx].
func (Instance) GetJiggleJointGravity ¶
Returns a [Vector2] representing the amount of gravity the Jiggle joint at [param joint_idx] is influenced by.
func (Instance) GetJiggleJointMass ¶
Returns the amount of mass of the jiggle joint at [param joint_idx].
func (Instance) GetJiggleJointOverride ¶
Returns a boolean that indicates whether the joint at [param joint_idx] is overriding the default Jiggle joint data defined in the modification.
func (Instance) GetJiggleJointStiffness ¶
Returns the stiffness of the Jiggle joint at [param joint_idx].
func (Instance) GetJiggleJointUseGravity ¶
Returns a boolean that indicates whether the joint at [param 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) JiggleDataChainLength ¶
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 ¶
func (Instance) SetGravity ¶
func (Instance) SetJiggleDataChainLength ¶
func (Instance) SetJiggleJointBone2dNode ¶
Sets the [Bone2D] node assigned to the Jiggle joint at [param joint_idx].
func (Instance) SetJiggleJointBoneIndex ¶
Sets the bone index, [param bone_idx], of the Jiggle joint at [param joint_idx]. When possible, this will also update the [code]bone2d_node[/code] 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 [param joint_idx].
func (Instance) SetJiggleJointGravity ¶
Sets the gravity vector of the Jiggle joint at [param joint_idx].
func (Instance) SetJiggleJointMass ¶
Sets the of mass of the Jiggle joint at [param joint_idx].
func (Instance) SetJiggleJointOverride ¶
Sets whether the Jiggle joint at [param joint_idx] should override the default Jiggle joint settings. Setting this to [code]true[/code] 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 [param joint_idx].
func (Instance) SetJiggleJointUseGravity ¶
Sets whether the Jiggle joint at [param joint_idx] should use gravity.
func (Instance) SetStiffness ¶
func (Instance) SetTargetNodepath ¶
func (Instance) SetUseColliders ¶
If [code]true[/code], the Jiggle modifier will take colliders into account, keeping them from entering into these collision objects.
Source Files