diff options
| author | Yuri Sizov <11782833+YuriSizov@users.noreply.github.com> | 2022-08-12 15:29:58 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-12 15:29:58 +0300 |
| commit | 65a1d86c4f4b893c6e72c5434c22a5ab7dcbe68b (patch) | |
| tree | c3616eb558ec9af0434281f8054dd2b54206201f /doc/classes/SkeletonModification2DFABRIK.xml | |
| parent | 67d40155206e7c15575ec9bd5b609075784ed746 (diff) | |
| parent | 1f72f48361e8a67a9473c99a27565fa6133c4b50 (diff) | |
Merge pull request #64196 from asmaloney/doc-params-3
[doc] Use "param" instead of "code" to refer to parameters #3
Diffstat (limited to 'doc/classes/SkeletonModification2DFABRIK.xml')
| -rw-r--r-- | doc/classes/SkeletonModification2DFABRIK.xml | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/classes/SkeletonModification2DFABRIK.xml b/doc/classes/SkeletonModification2DFABRIK.xml index 3108a55deb..1240174946 100644 --- a/doc/classes/SkeletonModification2DFABRIK.xml +++ b/doc/classes/SkeletonModification2DFABRIK.xml @@ -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> |