summaryrefslogtreecommitdiff
path: root/doc/classes/SkeletonModification2DPhysicalBones.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/SkeletonModification2DPhysicalBones.xml')
-rw-r--r--doc/classes/SkeletonModification2DPhysicalBones.xml30
1 files changed, 10 insertions, 20 deletions
diff --git a/doc/classes/SkeletonModification2DPhysicalBones.xml b/doc/classes/SkeletonModification2DPhysicalBones.xml
index d8aaf09a8e..e6bcb3c9d7 100644
--- a/doc/classes/SkeletonModification2DPhysicalBones.xml
+++ b/doc/classes/SkeletonModification2DPhysicalBones.xml
@@ -10,48 +10,38 @@
</tutorials>
<methods>
<method name="fetch_physical_bones">
- <return type="void">
- </return>
+ <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">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
+ <return type="NodePath" />
+ <argument index="0" name="joint_idx" type="int" />
<description>
Returns the [PhysicalBone2D] node at [code]joint_idx[/code].
</description>
</method>
<method name="set_physical_bone_node">
- <return type="void">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
- <argument index="1" name="physicalbone2d_node" type="NodePath">
- </argument>
+ <return type="void" />
+ <argument index="0" name="joint_idx" type="int" />
+ <argument index="1" name="physicalbone2d_node" type="NodePath" />
<description>
Sets the [PhysicalBone2D] node at [code]joint_idx[/code].
[b]Note:[/b] This is just the index used for this modification, not the bone index used in the [Skeleton2D].
</description>
</method>
<method name="start_simulation">
- <return type="void">
- </return>
- <argument index="0" name="bones" type="StringName[]" default="[ ]">
- </argument>
+ <return type="void" />
+ <argument index="0" name="bones" type="StringName[]" default="[]" />
<description>
Tell the [PhysicalBone2D] nodes to start simulating and interacting with the physics world.
Optionally, an array of bone names can be passed to this function, and that will cause only [PhysicalBone2D] nodes with those names to start simulating.
</description>
</method>
<method name="stop_simulation">
- <return type="void">
- </return>
- <argument index="0" name="bones" type="StringName[]" default="[ ]">
- </argument>
+ <return type="void" />
+ <argument index="0" name="bones" type="StringName[]" default="[]" />
<description>
Tell the [PhysicalBone2D] nodes to stop simulating and interacting with the physics world.
Optionally, an array of bone names can be passed to this function, and that will cause only [PhysicalBone2D] nodes with those names to stop simulating.