summaryrefslogtreecommitdiff
path: root/doc/classes/SkeletonModification2DJiggle.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-07-30 16:42:52 +0200
committerGitHub <noreply@github.com>2021-07-30 16:42:52 +0200
commit83ccf39adcefaa32325d607562f8f0889c215046 (patch)
tree61ea8e8a202e2998e745de04516a9a2f34c9be1b /doc/classes/SkeletonModification2DJiggle.xml
parenta7363f3dfd32ecff77d4d6937be9f232bfc699c7 (diff)
parent7adf4cc9b5de6701a41e27690a69b9892d5eed85 (diff)
Merge pull request #51067 from akien-mga/doc-return-argument-self-closing-tags
doc: Use self-closing tags for `return` and `argument`
Diffstat (limited to 'doc/classes/SkeletonModification2DJiggle.xml')
-rw-r--r--doc/classes/SkeletonModification2DJiggle.xml138
1 files changed, 46 insertions, 92 deletions
diff --git a/doc/classes/SkeletonModification2DJiggle.xml b/doc/classes/SkeletonModification2DJiggle.xml
index da25191dc0..8d3732e225 100644
--- a/doc/classes/SkeletonModification2DJiggle.xml
+++ b/doc/classes/SkeletonModification2DJiggle.xml
@@ -12,193 +12,147 @@
</tutorials>
<methods>
<method name="get_collision_mask" qualifiers="const">
- <return type="int">
- </return>
+ <return type="int" />
<description>
Returns the collision mask used by the Jiggle modifier when collisions are enabled.
</description>
</method>
<method name="get_jiggle_joint_bone2d_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 [Bone2D] node assigned to the Jiggle joint at [code]joint_idx[/code].
</description>
</method>
<method name="get_jiggle_joint_bone_index" qualifiers="const">
- <return type="int">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
+ <return type="int" />
+ <argument index="0" name="joint_idx" type="int" />
<description>
Returns the index of the [Bone2D] node assigned to the Jiggle joint at [code]joint_idx[/code].
</description>
</method>
<method name="get_jiggle_joint_damping" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
+ <return type="float" />
+ <argument index="0" name="joint_idx" type="int" />
<description>
Returns the amount of damping of the Jiggle joint at [code]joint_idx[/code].
</description>
</method>
<method name="get_jiggle_joint_gravity" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
+ <return type="Vector2" />
+ <argument index="0" name="joint_idx" type="int" />
<description>
Returns a [Vector2] representing 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">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
+ <return type="float" />
+ <argument 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">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
+ <return type="bool" />
+ <argument 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_stiffness" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
+ <return type="float" />
+ <argument 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">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
+ <return type="bool" />
+ <argument 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>
</method>
<method name="get_use_colliders" qualifiers="const">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns whether the jiggle modifier is taking physics colliders into account when solving.
</description>
</method>
<method name="set_collision_mask">
- <return type="void">
- </return>
- <argument index="0" name="collision_mask" type="int">
- </argument>
+ <return type="void" />
+ <argument index="0" name="collision_mask" type="int" />
<description>
Sets the collision mask that the Jiggle modifier will use when reacting to colliders, if the Jiggle modifier is set to take colliders into account.
</description>
</method>
<method name="set_jiggle_joint_bone2d_node">
- <return type="void">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
- <argument index="1" name="bone2d_node" type="NodePath">
- </argument>
+ <return type="void" />
+ <argument index="0" name="joint_idx" type="int" />
+ <argument index="1" name="bone2d_node" type="NodePath" />
<description>
Sets the [Bone2D] node assigned to the Jiggle joint at [code]joint_idx[/code].
</description>
</method>
<method name="set_jiggle_joint_bone_index">
- <return type="void">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
- <argument index="1" name="bone_idx" type="int">
- </argument>
+ <return type="void" />
+ <argument index="0" name="joint_idx" type="int" />
+ <argument 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]bone2d_node[/code] of the Jiggle joint based on data provided by the linked skeleton.
</description>
</method>
<method name="set_jiggle_joint_damping">
- <return type="void">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
- <argument index="1" name="damping" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="joint_idx" type="int" />
+ <argument 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">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
- <argument index="1" name="gravity" type="Vector2">
- </argument>
+ <return type="void" />
+ <argument index="0" name="joint_idx" type="int" />
+ <argument index="1" name="gravity" type="Vector2" />
<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">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
- <argument index="1" name="mass" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="joint_idx" type="int" />
+ <argument 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">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
- <argument index="1" name="override" type="bool">
- </argument>
+ <return type="void" />
+ <argument index="0" name="joint_idx" type="int" />
+ <argument 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 [code]true[/code] will make the joint use its own settings rather than the default ones attached to the modification.
</description>
</method>
<method name="set_jiggle_joint_stiffness">
- <return type="void">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
- <argument index="1" name="stiffness" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="joint_idx" type="int" />
+ <argument 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">
- </return>
- <argument index="0" name="joint_idx" type="int">
- </argument>
- <argument index="1" name="use_gravity" type="bool">
- </argument>
+ <return type="void" />
+ <argument index="0" name="joint_idx" type="int" />
+ <argument 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">
- </return>
- <argument index="0" name="use_colliders" type="bool">
- </argument>
+ <return type="void" />
+ <argument index="0" name="use_colliders" type="bool" />
<description>
If [code]true[/code], the Jiggle modifier will take colliders into account, keeping them from entering into these collision objects.
</description>