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/SkeletonModification3DJiggle.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/SkeletonModification3DJiggle.xml')
-rw-r--r-- | doc/classes/SkeletonModification3DJiggle.xml | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/classes/SkeletonModification3DJiggle.xml b/doc/classes/SkeletonModification3DJiggle.xml index ddbd5b4274..ef469d42ea 100644 --- a/doc/classes/SkeletonModification3DJiggle.xml +++ b/doc/classes/SkeletonModification3DJiggle.xml @@ -21,42 +21,42 @@ <return type="int" /> <param index="0" name="joint_idx" type="int" /> <description> - Returns the bone index of the bone assigned to the Jiggle joint at [code]joint_idx[/code]. + Returns the bone index of the bone assigned to the Jiggle joint at [param joint_idx]. </description> </method> <method name="get_jiggle_joint_bone_name" qualifiers="const"> <return type="String" /> <param index="0" name="joint_idx" type="int" /> <description> - Returns the name of the bone that is assigned to the Jiggle joint at [code]joint_idx[/code]. + Returns the name of the bone that is assigned to the Jiggle joint at [param joint_idx]. </description> </method> <method name="get_jiggle_joint_damping" qualifiers="const"> <return type="float" /> <param index="0" name="joint_idx" type="int" /> <description> - Returns the amount of dampening of the Jiggle joint at [code]joint_idx[/code]. + Returns the amount of dampening of the Jiggle joint at [param joint_idx]. </description> </method> <method name="get_jiggle_joint_gravity" qualifiers="const"> <return type="Vector3" /> <param index="0" name="joint_idx" type="int" /> <description> - Returns a [Vector3] representign the amount of gravity the Jiggle joint at [code]joint_idx[/code] is influenced by. + Returns a [Vector3] representign the amount of gravity the Jiggle joint at [param joint_idx] is influenced by. </description> </method> <method name="get_jiggle_joint_mass" qualifiers="const"> <return type="float" /> <param index="0" name="joint_idx" type="int" /> <description> - Returns the amount of mass of the Jiggle joint at [code]joint_idx[/code]. + Returns the amount of mass of the Jiggle joint at [param joint_idx]. </description> </method> <method name="get_jiggle_joint_override" qualifiers="const"> <return type="bool" /> <param index="0" name="joint_idx" type="int" /> <description> - Returns a boolean that indicates whether the joint at [code]joint_idx[/code] is overriding the default jiggle joint data defined in the modification. + Returns a boolean that indicates whether the joint at [param joint_idx] is overriding the default jiggle joint data defined in the modification. </description> </method> <method name="get_jiggle_joint_roll" qualifiers="const"> @@ -70,14 +70,14 @@ <return type="float" /> <param index="0" name="joint_idx" type="int" /> <description> - Returns the stiffness of the Jiggle joint at [code]joint_idx[/code]. + Returns the stiffness of the Jiggle joint at [param joint_idx]. </description> </method> <method name="get_jiggle_joint_use_gravity" qualifiers="const"> <return type="bool" /> <param index="0" name="joint_idx" type="int" /> <description> - Returns a boolean that indicates whether the joint at [code]joint_idx[/code] is using gravity or not. + Returns a boolean that indicates whether the joint at [param joint_idx] is using gravity or not. </description> </method> <method name="get_use_colliders" qualifiers="const"> @@ -98,7 +98,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 Jiggle joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_name[/code] of the Jiggle joint based on data provided by the [Skeleton3D]. + Sets the bone index, [param bone_idx], of the Jiggle joint at [param joint_idx]. When possible, this will also update the [code]bone_name[/code] of the Jiggle joint based on data provided by the [Skeleton3D]. </description> </method> <method name="set_jiggle_joint_bone_name"> @@ -106,7 +106,7 @@ <param index="0" name="joint_idx" type="int" /> <param index="1" name="name" type="String" /> <description> - Sets the bone name, [code]bone_name[/code], of the Jiggle joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_index[/code] of the Jiggle joint based on data provided by the [Skeleton3D]. + Sets the bone name, [param name], of the Jiggle joint at [param joint_idx]. When possible, this will also update the [code]bone_index[/code] of the Jiggle joint based on data provided by the [Skeleton3D]. </description> </method> <method name="set_jiggle_joint_damping"> @@ -114,7 +114,7 @@ <param index="0" name="joint_idx" type="int" /> <param index="1" name="damping" type="float" /> <description> - Sets the amount of dampening of the Jiggle joint at [code]joint_idx[/code]. + Sets the amount of dampening of the Jiggle joint at [param joint_idx]. </description> </method> <method name="set_jiggle_joint_gravity"> @@ -122,7 +122,7 @@ <param index="0" name="joint_idx" type="int" /> <param index="1" name="gravity" type="Vector3" /> <description> - Sets the gravity vector of the Jiggle joint at [code]joint_idx[/code]. + Sets the gravity vector of the Jiggle joint at [param joint_idx]. </description> </method> <method name="set_jiggle_joint_mass"> @@ -130,7 +130,7 @@ <param index="0" name="joint_idx" type="int" /> <param index="1" name="mass" type="float" /> <description> - Sets the of mass of the Jiggle joint at [code]joint_idx[/code]. + Sets the of mass of the Jiggle joint at [param joint_idx]. </description> </method> <method name="set_jiggle_joint_override"> @@ -138,7 +138,7 @@ <param index="0" name="joint_idx" type="int" /> <param index="1" name="override" type="bool" /> <description> - Sets whether the Jiggle joint at [code]joint_idx[/code] should override the default Jiggle joint settings. Setting this to true will make the joint use its own settings rather than the default ones attached to the modification. + Sets whether the Jiggle joint at [param joint_idx] should override the default Jiggle joint settings. Setting this to true will make the joint use its own settings rather than the default ones attached to the modification. </description> </method> <method name="set_jiggle_joint_roll"> @@ -154,7 +154,7 @@ <param index="0" name="joint_idx" type="int" /> <param index="1" name="stiffness" type="float" /> <description> - Sets the of stiffness of the Jiggle joint at [code]joint_idx[/code]. + Sets the of stiffness of the Jiggle joint at [param joint_idx]. </description> </method> <method name="set_jiggle_joint_use_gravity"> @@ -162,7 +162,7 @@ <param index="0" name="joint_idx" type="int" /> <param index="1" name="use_gravity" type="bool" /> <description> - Sets whether the Jiggle joint at [code]joint_idx[/code] should use gravity. + Sets whether the Jiggle joint at [param joint_idx] should use gravity. </description> </method> <method name="set_use_colliders"> |