Index · Object → RefCounted → Resource → SkeletonModification2D → SkeletonModification2DJiggle

SkeletonModification2DJiggle

A modification that jiggles Bone2D nodes as they move towards a target.

Class Description

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.

Properties

var damping: float = 0.75

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.

var gravity: Vector2 = Vector2(0, 6)

The default amount of gravity applied to the Jiggle joints, if they are not overridden.

var jiggle_data_chain_length: int = 0

The amount of Jiggle joints in the Jiggle modification.

var mass: float = 0.75

The default amount of mass assigned to the Jiggle joints, if they are not overridden. Higher values lead to faster movements and more overshooting.

var stiffness: float = 3.0

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.

var target_nodepath: NodePath = NodePath("")

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.

var use_gravity: bool = false

Whether the gravity vector, gravity, should be applied to the Jiggle joints, assuming they are not overriding the default settings.

Inherited from SkeletonModification2D (2)
var enabled: bool = true
Inherited from Resource (4)

Methods

func get_collision_mask() -> int

Returns the collision mask used by the Jiggle modifier when collisions are enabled.

func get_jiggle_joint_bone2d_node(joint_idx: int) -> NodePath

Returns the Bone2D node assigned to the Jiggle joint at joint_idx.

func get_jiggle_joint_bone_index(joint_idx: int) -> int

Returns the index of the Bone2D node assigned to the Jiggle joint at joint_idx.

func get_jiggle_joint_damping(joint_idx: int) -> float

Returns the amount of damping of the Jiggle joint at joint_idx.

func get_jiggle_joint_gravity(joint_idx: int) -> Vector2

Returns a Vector2 representing the amount of gravity the Jiggle joint at joint_idx is influenced by.

func get_jiggle_joint_mass(joint_idx: int) -> float

Returns the amount of mass of the jiggle joint at joint_idx.

func get_jiggle_joint_override(joint_idx: int) -> bool

Returns a boolean that indicates whether the joint at joint_idx is overriding the default Jiggle joint data defined in the modification.

func get_jiggle_joint_stiffness(joint_idx: int) -> float

Returns the stiffness of the Jiggle joint at joint_idx.

func get_jiggle_joint_use_gravity(joint_idx: int) -> bool

Returns a boolean that indicates whether the joint at joint_idx is using gravity or not.

func get_use_colliders() -> bool

Returns whether the jiggle modifier is taking physics colliders into account when solving.

func reset() -> void

Resets the internal jiggle simulation state to the current bone positions, clearing velocity, acceleration, and accumulated forces.

func set_collision_mask(collision_mask: int) -> void

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 set_jiggle_joint_bone2d_node(joint_idx: int, bone2d_node: NodePath) -> void

Sets the Bone2D node assigned to the Jiggle joint at joint_idx.

func set_jiggle_joint_bone_index(joint_idx: int, bone_idx: int) -> void

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 set_jiggle_joint_damping(joint_idx: int, damping: float) -> void

Sets the amount of damping of the Jiggle joint at joint_idx.

func set_jiggle_joint_gravity(joint_idx: int, gravity: Vector2) -> void

Sets the gravity vector of the Jiggle joint at joint_idx.

func set_jiggle_joint_mass(joint_idx: int, mass: float) -> void

Sets the of mass of the Jiggle joint at joint_idx.

func set_jiggle_joint_override(joint_idx: int, override: bool) -> void

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 set_jiggle_joint_stiffness(joint_idx: int, stiffness: float) -> void

Sets the of stiffness of the Jiggle joint at joint_idx.

func set_jiggle_joint_use_gravity(joint_idx: int, use_gravity: bool) -> void

Sets whether the Jiggle joint at joint_idx should use gravity.

func set_use_colliders(use_colliders: bool) -> void

If true, the Jiggle modifier will take colliders into account, keeping them from entering into these collision objects.

Inherited from SkeletonModification2D (9)
func _draw_editor_gizmo() -> void
func _execute(delta: float) -> void
func _setup_modification(modification_stack: SkeletonModificationStack2D) -> void
func clamp_angle(angle: float, min: float, max: float, invert: bool) -> float
func get_is_setup() -> bool
func set_editor_draw_gizmo(draw_gizmo: bool) -> void
func set_is_setup(is_setup: bool) -> void
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)