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

Rename the argument tag to param in XML documentation

Browse Source
This commit is contained in:
Yuri Sizov
2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
doc/classes/SkeletonModification3DJiggle.xml
View File

@@ -19,63 +19,63 @@
</method>
<method name="get_jiggle_joint_bone_index" qualifiers="const">
<return type="int" />
<argument index="0" name="joint_idx" 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].
</description>
</method>
<method name="get_jiggle_joint_bone_name" qualifiers="const">
<return type="String" />
<argument index="0" name="joint_idx" type="int" />
<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].
</description>
</method>
<method name="get_jiggle_joint_damping" qualifiers="const">
<return type="float" />
<argument index="0" name="joint_idx" type="int" />
<param index="0" name="joint_idx" type="int" />
<description>
Returns the amount of dampening of the Jiggle joint at [code]joint_idx[/code].
</description>
</method>
<method name="get_jiggle_joint_gravity" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="joint_idx" type="int" />
<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.
</description>
</method>
<method name="get_jiggle_joint_mass" qualifiers="const">
<return type="float" />
<argument index="0" name="joint_idx" type="int" />
<param index="0" name="joint_idx" type="int" />
<description>
Returns the amount of mass of the Jiggle joint at [code]joint_idx[/code].
</description>
</method>
<method name="get_jiggle_joint_override" qualifiers="const">
<return type="bool" />
<argument index="0" name="joint_idx" type="int" />
<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.
</description>
</method>
<method name="get_jiggle_joint_roll" qualifiers="const">
<return type="float" />
<argument index="0" name="joint_idx" type="int" />
<param index="0" name="joint_idx" type="int" />
<description>
Returns the amount of roll/twist applied to the bone that the Jiggle joint is applied to.
</description>
</method>
<method name="get_jiggle_joint_stiffness" qualifiers="const">
<return type="float" />
<argument index="0" name="joint_idx" type="int" />
<param index="0" name="joint_idx" type="int" />
<description>
Returns the stiffness of the Jiggle joint at [code]joint_idx[/code].
</description>
</method>
<method name="get_jiggle_joint_use_gravity" qualifiers="const">
<return type="bool" />
<argument index="0" name="joint_idx" type="int" />
<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.
</description>
@@ -88,86 +88,86 @@
</method>
<method name="set_collision_mask">
<return type="void" />
<argument index="0" name="mask" type="int" />
<param index="0" name="mask" type="int" />
<description>
Sets the collision mask that the Jiggle modifier takes into account when performing physics calculations.
</description>
</method>
<method name="set_jiggle_joint_bone_index">
<return type="void" />
<argument index="0" name="joint_idx" type="int" />
<argument index="1" name="bone_idx" type="int" />
<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].
</description>
</method>
<method name="set_jiggle_joint_bone_name">
<return type="void" />
<argument index="0" name="joint_idx" type="int" />
<argument index="1" name="name" type="String" />
<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].
</description>
</method>
<method name="set_jiggle_joint_damping">
<return type="void" />
<argument index="0" name="joint_idx" type="int" />
<argument index="1" name="damping" type="float" />
<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].
</description>
</method>
<method name="set_jiggle_joint_gravity">
<return type="void" />
<argument index="0" name="joint_idx" type="int" />
<argument index="1" name="gravity" type="Vector3" />
<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].
</description>
</method>
<method name="set_jiggle_joint_mass">
<return type="void" />
<argument index="0" name="joint_idx" type="int" />
<argument index="1" name="mass" type="float" />
<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].
</description>
</method>
<method name="set_jiggle_joint_override">
<return type="void" />
<argument index="0" name="joint_idx" type="int" />
<argument index="1" name="override" type="bool" />
<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.
</description>
</method>
<method name="set_jiggle_joint_roll">
<return type="void" />
<argument index="0" name="joint_idx" type="int" />
<argument index="1" name="roll" type="float" />
<param index="0" name="joint_idx" type="int" />
<param index="1" name="roll" type="float" />
<description>
Sets the amount of roll/twist on the bone the Jiggle joint is attached to.
</description>
</method>
<method name="set_jiggle_joint_stiffness">
<return type="void" />
<argument index="0" name="joint_idx" type="int" />
<argument index="1" name="stiffness" type="float" />
<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].
</description>
</method>
<method name="set_jiggle_joint_use_gravity">
<return type="void" />
<argument index="0" name="joint_idx" type="int" />
<argument index="1" name="use_gravity" type="bool" />
<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.
</description>
</method>
<method name="set_use_colliders">
<return type="void" />
<argument index="0" name="use_colliders" type="bool" />
<param index="0" name="use_colliders" type="bool" />
<description>
When [code]true[/code], the Jiggle modifier will use raycasting to prevent the Jiggle joints from rotating themselves into collision objects when solving.
</description>