Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

PhysicalBone2D

Inherits: RigidBody2D < PhysicsBody2D < CollisionObject2D < Node2D < CanvasItem < Node < Object

A 2D node that can be used for physically aware bones in 2D.

Description

The PhysicalBone2D node is a RigidBody2D-based node that can be used to make Bone2D nodes in a Skeleton2D react to physics. This node is very similar to the PhysicalBone3D node, just for 2D instead of 3D.

Note: To have the Bone2D nodes visually follow the PhysicalBone2D node, use a SkeletonModification2DPhysicalBones modification on the Skeleton2D node with the Bone2D nodes.

Note: The PhysicalBone2D node does not automatically create a Joint2D node to keep PhysicalBone2D nodes together. You will need to create these manually. For most cases, you want to use a PinJoint2D node. The PhysicalBone2D node can automatically configure the Joint2D node once it's been created as a child node.

Properties

bool

auto_configure_joint

true

int

bone2d_index

-1

NodePath

bone2d_nodepath

NodePath("")

bool

follow_bone_when_simulating

false

bool

simulate_physics

false

Methods

Joint2D

get_joint ( ) const

bool

is_simulating_physics ( ) const

Property Descriptions

bool auto_configure_joint = true

  • void set_auto_configure_joint ( bool value )

  • bool get_auto_configure_joint ( )

If true, the PhysicalBone2D node will automatically configure the first Joint2D child node. The automatic configuration is limited to setting up the node properties and positioning the Joint2D.

int bone2d_index = -1

  • void set_bone2d_index ( int value )

  • int get_bone2d_index ( )

The index of the Bone2D node that this PhysicalBone2D node is supposed to be simulating.

NodePath bone2d_nodepath = NodePath("")

The NodePath to the Bone2D node that this PhysicalBone2D node is supposed to be simulating.

bool follow_bone_when_simulating = false

  • void set_follow_bone_when_simulating ( bool value )

  • bool get_follow_bone_when_simulating ( )

If true, the PhysicalBone2D will keep the transform of the bone it is bound to when simulating physics.

bool simulate_physics = false

  • void set_simulate_physics ( bool value )

  • bool get_simulate_physics ( )

If true, the PhysicalBone2D will start simulating using physics. If false, the PhysicalBone2D will follow the transform of the Bone2D node.

Note: To have the Bone2D nodes visually follow the PhysicalBone2D node, use a SkeletonModification2DPhysicalBones modification on the Skeleton2D node with the Bone2D nodes.

Method Descriptions

Joint2D get_joint ( ) const

Returns the first Joint2D child node, if one exists. This is mainly a helper function to make it easier to get the Joint2D that the PhysicalBone2D is autoconfiguring.

bool is_simulating_physics ( ) const

Returns a boolean that indicates whether the PhysicalBone2D node is running and simulating using the Godot 2D physics engine. When true, the PhysicalBone2D node is using physics.