noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

[doc] Use "param" instead of "code" to refer to parameters #3

Browse Source
This commit is contained in:
Andy Maloney
2022-08-09 22:00:19 -04:00
parent 317ced8204
commit 1f72f48361
50 changed files with 362 additions and 362 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/classes/SkeletonModification2DFABRIK.xml
View File

@@ -17,21 +17,21 @@
<return type="NodePath" />
<param index="0" name="joint_idx" type="int" />
<description>
Returns the [Bone2D] node assigned to the FABRIK joint at [code]joint_idx[/code].
Returns the [Bone2D] node assigned to the FABRIK joint at [param joint_idx].
</description>
</method>
<method name="get_fabrik_joint_bone_index" qualifiers="const">
<return type="int" />
<param index="0" name="joint_idx" type="int" />
<description>
Returns the index of the [Bone2D] node assigned to the FABRIK joint at [code]joint_idx[/code].
Returns the index of the [Bone2D] node assigned to the FABRIK joint at [param joint_idx].
</description>
</method>
<method name="get_fabrik_joint_magnet_position" qualifiers="const">
<return type="Vector2" />
<param index="0" name="joint_idx" type="int" />
<description>
Returns the magnet position vector for the joint at [code]joint_idx[/code].
Returns the magnet position vector for the joint at [param joint_idx].
</description>
</method>
<method name="get_fabrik_joint_use_target_rotation" qualifiers="const">
@@ -46,7 +46,7 @@
<param index="0" name="joint_idx" type="int" />
<param index="1" name="bone2d_nodepath" type="NodePath" />
<description>
Sets the [Bone2D] node assigned to the FABRIK joint at [code]joint_idx[/code].
Sets the [Bone2D] node assigned to the FABRIK joint at [param joint_idx].
</description>
</method>
<method name="set_fabrik_joint_bone_index">
@@ -54,7 +54,7 @@
<param index="0" name="joint_idx" type="int" />
<param index="1" name="bone_idx" type="int" />
<description>
Sets the bone index, [code]bone_index[/code], of the FABRIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone2d_node[/code] of the FABRIK joint based on data provided by the linked skeleton.
Sets the bone index, [param bone_idx], of the FABRIK joint at [param joint_idx]. When possible, this will also update the [code]bone2d_node[/code] of the FABRIK joint based on data provided by the linked skeleton.
</description>
</method>
<method name="set_fabrik_joint_magnet_position">
@@ -62,7 +62,7 @@
<param index="0" name="joint_idx" type="int" />
<param index="1" name="magnet_position" type="Vector2" />
<description>
Sets the magnet position vector for the joint at [code]joint_idx[/code].
Sets the magnet position vector for the joint at [param joint_idx].
</description>
</method>
<method name="set_fabrik_joint_use_target_rotation">
@@ -70,7 +70,7 @@
<param index="0" name="joint_idx" type="int" />
<param index="1" name="use_target_rotation" type="bool" />
<description>
Sets whether the joint at [code]joint_idx[/code] will use the target node's rotation rather than letting FABRIK rotate the node.
Sets whether the joint at [param joint_idx] will use the target node's rotation rather than letting FABRIK rotate the node.
[b]Note:[/b] This option only works for the tip/final joint in the chain. For all other nodes, this option will be ignored.
</description>
</method>