SkeletonModification2DJiggle
A modification that jiggles Bone2D nodes as they move towards a target.
A modification that jiggles Bone2D nodes as they move towards a target.
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.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
SkeletonModification2DJiggleConstructor
public SkeletonModification2DJiggle();Properties7
DampingProperty
public float Damping { get; set; }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.
GravityProperty
public Vector2 Gravity { get; set; }The default amount of gravity applied to the Jiggle joints, if they are not overridden.
JiggleDataChainLengthProperty
public int JiggleDataChainLength { get; set; }The amount of Jiggle joints in the Jiggle modification.
MassProperty
public float Mass { get; set; }The default amount of mass assigned to the Jiggle joints, if they are not overridden. Higher values lead to faster movements and more overshooting.
StiffnessProperty
public float Stiffness { get; set; }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.
TargetEntitypathProperty
public EntityPath TargetEntitypath { get; set; }The EntityPath 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.
UseGravityProperty
public bool UseGravity { get; set; }Whether the gravity vector, SkeletonModification2DJiggle.Gravity, should be applied to the Jiggle joints, assuming they are not overriding the default settings.
Methods35
GetCollisionMaskint
public int GetCollisionMask();Returns the collision mask used by the Jiggle modifier when collisions are enabled.
intGetDampingfloat
public float GetDamping();floatGetGravityVector2
public Vector2 GetGravity();Vector2GetJiggleDataChainLengthint
public int GetJiggleDataChainLength();intGetJiggleJointBone2DEntityEntityPath
public EntityPath GetJiggleJointBone2DEntity(int jointIdx);Returns the Bone2D node assigned to the Jiggle joint at joint_idx.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
EntityPathGetJiggleJointBoneIndexint
public int GetJiggleJointBoneIndex(int jointIdx);Returns the index of the Bone2D node assigned to the Jiggle joint at joint_idx.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
intGetJiggleJointDampingfloat
public float GetJiggleJointDamping(int jointIdx);Returns the amount of damping of the Jiggle joint at joint_idx.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
floatGetJiggleJointGravityVector2
public Vector2 GetJiggleJointGravity(int jointIdx);Returns a Vector2 representing the amount of gravity the Jiggle joint at joint_idx is influenced by.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
Vector2GetJiggleJointMassfloat
public float GetJiggleJointMass(int jointIdx);Returns the amount of mass of the jiggle joint at joint_idx.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
floatGetJiggleJointOverridebool
public bool GetJiggleJointOverride(int jointIdx);Returns a boolean that indicates whether the joint at joint_idx is overriding the default Jiggle joint data defined in the modification.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
boolGetJiggleJointStiffnessfloat
public float GetJiggleJointStiffness(int jointIdx);Returns the stiffness of the Jiggle joint at joint_idx.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
floatGetJiggleJointUseGravitybool
public bool GetJiggleJointUseGravity(int jointIdx);Returns a boolean that indicates whether the joint at joint_idx is using gravity or not.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
boolGetMassfloat
public float GetMass();floatGetStiffnessfloat
public float GetStiffness();floatGetTargetEntityEntityPath
public EntityPath GetTargetEntity();EntityPathGetUseCollidersbool
public bool GetUseColliders();Returns whether the jiggle modifier is taking physics colliders into account when solving.
boolGetUseGravitybool
public bool GetUseGravity();boolResetvoid
public void Reset();Resets the internal jiggle simulation state to the current bone positions, clearing velocity, acceleration, and accumulated forces.
SetCollisionMaskvoid
public void SetCollisionMask(int collisionMask);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.
| Name | Type | Default |
|---|---|---|
collisionMask | int | — |
SetDampingvoid
public void SetDamping(float damping);| Name | Type | Default |
|---|---|---|
damping | float | — |
SetGravityvoid
public void SetGravity(Vector2 gravity);| Name | Type | Default |
|---|---|---|
gravity | Vector2 | — |
SetJiggleDataChainLengthvoid
public void SetJiggleDataChainLength(int length);| Name | Type | Default |
|---|---|---|
length | int | — |
SetJiggleJointBone2DEntityvoid
public void SetJiggleJointBone2DEntity(int jointIdx, EntityPath bone2DEntity);Sets the Bone2D node assigned to the Jiggle joint at joint_idx.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
bone2DEntity | EntityPath | — |
SetJiggleJointBoneIndexvoid
public void SetJiggleJointBoneIndex(int jointIdx, int boneIdx);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.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
boneIdx | int | — |
SetJiggleJointDampingvoid
public void SetJiggleJointDamping(int jointIdx, float damping);Sets the amount of damping of the Jiggle joint at joint_idx.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
damping | float | — |
SetJiggleJointGravityvoid
public void SetJiggleJointGravity(int jointIdx, Vector2 gravity);Sets the gravity vector of the Jiggle joint at joint_idx.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
gravity | Vector2 | — |
SetJiggleJointMassvoid
public void SetJiggleJointMass(int jointIdx, float mass);Sets the of mass of the Jiggle joint at joint_idx.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
mass | float | — |
SetJiggleJointOverridevoid
public void SetJiggleJointOverride(int jointIdx, bool @override);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.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
override | bool | — |
SetJiggleJointStiffnessvoid
public void SetJiggleJointStiffness(int jointIdx, float stiffness);Sets the of stiffness of the Jiggle joint at joint_idx.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
stiffness | float | — |
SetJiggleJointUseGravityvoid
public void SetJiggleJointUseGravity(int jointIdx, bool useGravity);Sets whether the Jiggle joint at joint_idx should use gravity.
| Name | Type | Default |
|---|---|---|
jointIdx | int | — |
useGravity | bool | — |
SetMassvoid
public void SetMass(float mass);| Name | Type | Default |
|---|---|---|
mass | float | — |
SetStiffnessvoid
public void SetStiffness(float stiffness);| Name | Type | Default |
|---|---|---|
stiffness | float | — |
SetTargetEntityvoid
public void SetTargetEntity(EntityPath targetEntitypath);| Name | Type | Default |
|---|---|---|
targetEntitypath | EntityPath | — |
SetUseCollidersvoid
public void SetUseColliders(bool useColliders);If true, the Jiggle modifier will take colliders into account, keeping them from entering into these collision objects.
| Name | Type | Default |
|---|---|---|
useColliders | bool | — |
SetUseGravityvoid
public void SetUseGravity(bool useGravity);| Name | Type | Default |
|---|---|---|
useGravity | bool | — |