summaryrefslogtreecommitdiff
path: root/doc/classes/SkeletonModification2DLookAt.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/SkeletonModification2DLookAt.xml')
-rw-r--r--doc/classes/SkeletonModification2DLookAt.xml45
1 files changed, 15 insertions, 30 deletions
diff --git a/doc/classes/SkeletonModification2DLookAt.xml b/doc/classes/SkeletonModification2DLookAt.xml
index b0fa0e5a01..998a897d20 100644
--- a/doc/classes/SkeletonModification2DLookAt.xml
+++ b/doc/classes/SkeletonModification2DLookAt.xml
@@ -10,82 +10,67 @@
</tutorials>
<methods>
<method name="get_additional_rotation" qualifiers="const">
- <return type="float">
- </return>
+ <return type="float" />
<description>
Returns the amount of additional rotation that is applied after the LookAt modification executes.
</description>
</method>
<method name="get_constraint_angle_invert" qualifiers="const">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns whether the constraints to this modification are inverted or not.
</description>
</method>
<method name="get_constraint_angle_max" qualifiers="const">
- <return type="float">
- </return>
+ <return type="float" />
<description>
Returns the constraint's maximum allowed angle.
</description>
</method>
<method name="get_constraint_angle_min" qualifiers="const">
- <return type="float">
- </return>
+ <return type="float" />
<description>
Returns the constraint's minimum allowed angle.
</description>
</method>
<method name="get_enable_constraint" qualifiers="const">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns [code]true[/code] if the LookAt modification is using constraints.
</description>
</method>
<method name="set_additional_rotation">
- <return type="void">
- </return>
- <argument index="0" name="rotation" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="rotation" type="float" />
<description>
Sets the amount of additional rotation that is to be applied after executing the modification. This allows for offsetting the results by the inputted rotation amount.
</description>
</method>
<method name="set_constraint_angle_invert">
- <return type="void">
- </return>
- <argument index="0" name="invert" type="bool">
- </argument>
+ <return type="void" />
+ <argument index="0" name="invert" type="bool" />
<description>
When [code]true[/code], the modification will use an inverted joint constraint.
An inverted joint constraint only constraints the [Bone2D] to the angles [i]outside of[/i] the inputted minimum and maximum angles. For this reason, it is referred to as an inverted joint constraint, as it constraints the joint to the outside of the inputted values.
</description>
</method>
<method name="set_constraint_angle_max">
- <return type="void">
- </return>
- <argument index="0" name="angle_max" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="angle_max" type="float" />
<description>
Sets the constraint's maximum allowed angle.
</description>
</method>
<method name="set_constraint_angle_min">
- <return type="void">
- </return>
- <argument index="0" name="angle_min" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="angle_min" type="float" />
<description>
Sets the constraint's minimum allowed angle.
</description>
</method>
<method name="set_enable_constraint">
- <return type="void">
- </return>
- <argument index="0" name="enable_constraint" type="bool">
- </argument>
+ <return type="void" />
+ <argument index="0" name="enable_constraint" type="bool" />
<description>
Sets whether this modification will use constraints or not. When [code]true[/code], constraints will be applied when solving the LookAt modification.
</description>