pandemonium_engine/modules/skeleton_2d/doc_classes/SkeletonModification2DPhysicalBones.xml

52 lines
1.9 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="SkeletonModification2DPhysicalBones" inherits="SkeletonModification2D" version="3.12">
<brief_description>
A modification that applies the transforms of [PhysicalBone2D] nodes to [Bone2D] nodes.
</brief_description>
<description>
This modification takes the transforms of [PhysicalBone2D] nodes and applies them to [Bone2D] nodes. This allows the [Bone2D] nodes to react to physics thanks to the linked [PhysicalBone2D] nodes.
</description>
<tutorials>
</tutorials>
<methods>
<method name="fetch_physical_bones">
<return type="void" />
<description>
Empties the list of [PhysicalBone2D] nodes and populates it will all [PhysicalBone2D] nodes that are children of the [Skeleton2D].
</description>
</method>
<method name="get_physical_bone_node" qualifiers="const">
<return type="NodePath" />
<argument index="0" name="joint_idx" type="int" />
<description>
</description>
</method>
<method name="set_physical_bone_node">
<return type="void" />
<argument index="0" name="joint_idx" type="int" />
<argument index="1" name="physicalbone2d_node" type="NodePath" />
<description>
</description>
</method>
<method name="start_simulation">
<return type="void" />
<argument index="0" name="bones" type="PoolStringArray" default="PoolStringArray( )" />
<description>
</description>
</method>
<method name="stop_simulation">
<return type="void" />
<argument index="0" name="bones" type="PoolStringArray" default="PoolStringArray( )" />
<description>
</description>
</method>
</methods>
<members>
<member name="physical_bone_chain_length" type="int" setter="set_physical_bone_chain_length" getter="get_physical_bone_chain_length" default="0">
The amount of [PhysicalBone2D] nodes linked in this modification.
</member>
</members>
<constants>
</constants>
</class>