Property Descriptions

bool auto_configure_joint = true

• void set_auto_configure_joint ( bool value )
• bool get_auto_configure_joint ( )

If true, the PhysicalBone2D 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 that this PhysicalBone2D should simulate.

NodePath bone2d_nodepath = NodePath("")

• void set_bone2d_nodepath ( NodePath value )
• NodePath get_bone2d_nodepath ( )

The NodePath to the Bone2D that this PhysicalBone2D should simulate.

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 Bone2Ds visually follow the PhysicalBone2D, 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 is running and simulating using the Godot 2D physics engine. When true, the PhysicalBone2D node is using physics.