WiggleBone Plugin for Godot Engine (4.x)

Adds jiggle physics to bones of a Skeleton3D. It reacts to animated or global motion as if it's connected with a rubber band to its initial position. As it reacts to acceleration instead of velocity, bones of constantly moving objects will not "lag behind" and have a more realistic behaviour.

The node inherits from BoneAttachment3D and can also be used as such. It overrides the bone's global pose respecting the current pose, so the bone pose still be animated.

See the examples directory for some examples.

• Installation
• Usage
• Node Properties
• WiggleProperties Resource
• Pose Modes
• Functions
• Testing in Editor
• Breaking Changes from the Godot 3.x Version

Note Requires Godot 4.x. For Godot 3.x, see the 3.x branch.

Installation

1. Search for wigglebone in the AssetLib editor tab
2. Download and install the plugin
3. Enable the plugin in the project settings via the Plugins tab

or...

1. Clone this repository or download the archive
2. Copy the folder addons/wigglebone to your project's addons folder (create it if needed)
3. Enable the plugin in the project settings via the Plugins tab

Usage

You can now add WiggleBone nodes to a Skeleton3D. See the example scenes in examples.

Node Properties

Warning Should work when BoneAttachment3D.override_pose is true. Using BoneAttachment3D.use_external_skeleton is not supported yet.

WiggleProperties Resource

Properties are stored in a separate WiggleProperties resource type. This way, bone properties can be reused (saved) and shared between multiple bones, for example, on symetric bones.

Additional Properties for Pose Mode Rotation

Additional Properties for Pose Mode Dislocation

Pose Modes

Two different pose modes are supported.

Rotation (WiggleProperties.Mode.ROTATION)

The bone rotates around its origin relative to the its pose. The rotation angle can be limited using Max Degrees (max_degrees). It has an upper limit of 90° due to the implementation. All values have a soft limit.

Dislocation (WiggleProperties.Mode.DISLOCATION)

The bone moves around its origin relative to its pose without rotating. The distance can be limited using Max Distance (max_distance). All values have a soft limit.

Functions

This functions can be called on the WiggleBone node.

apply_impulse(impulse: Vector3, global := true) -> void

Adds a single impulse force for the next frame. If global is false, the force is relative to the bone's pose.

reset() -> void

Resets movement and resets the bone to its pose. Can be used, for example, after "teleporting" the character (moving instantaneously a long distance) to prevent overshooting.

Testing in Editor

When a WiggleBone node is selected in the scene tree, a force can be applied to it by dragging its handle. The handle appears at the bone's end when Rotation mode is used or at the origin when Dislocation mode is used, respectively. Another way is to drag or rotate the Skeleton3D or one of its parents.

Disabling Editor Gizmo

The editor gizmo (cone/sphere) can be hidden in the 3D viewport by disabling it in View > Gizmos > WiggleBone

Breaking Changes from the Godot 3.x Version

WiggleProperties

• mass_center (Vector3) was replaced by length (float)
• const_force was renamed to const_force_global