summaryrefslogtreecommitdiffstats
path: root/doc/classes/Transform2D.xml
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2022-08-06 21:11:48 +0300
committerYuri Sizov <yuris@humnom.net>2022-08-08 22:34:31 +0300
commitc5d7115038de5f83cb83e08748615a84fc26bee2 (patch)
tree13b9b42aac25f7769428ef91f637e260b768f25d /doc/classes/Transform2D.xml
parent35c1eae8d70eb6ae49495339b95f89bcd084c3f2 (diff)
downloadredot-engine-c5d7115038de5f83cb83e08748615a84fc26bee2.tar.gz
Rename the argument tag to param in XML documentation
Diffstat (limited to 'doc/classes/Transform2D.xml')
-rw-r--r--doc/classes/Transform2D.xml68
1 files changed, 34 insertions, 34 deletions
diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml
index 9979a73527..3b76348c09 100644
--- a/doc/classes/Transform2D.xml
+++ b/doc/classes/Transform2D.xml
@@ -22,34 +22,34 @@
</constructor>
<constructor name="Transform2D">
<return type="Transform2D" />
- <argument index="0" name="from" type="Transform2D" />
+ <param index="0" name="from" type="Transform2D" />
<description>
Constructs a [Transform2D] as a copy of the given [Transform2D].
</description>
</constructor>
<constructor name="Transform2D">
<return type="Transform2D" />
- <argument index="0" name="rotation" type="float" />
- <argument index="1" name="position" type="Vector2" />
+ <param index="0" name="rotation" type="float" />
+ <param index="1" name="position" type="Vector2" />
<description>
Constructs the transform from a given angle (in radians) and position.
</description>
</constructor>
<constructor name="Transform2D">
<return type="Transform2D" />
- <argument index="0" name="rotation" type="float" />
- <argument index="1" name="scale" type="Vector2" />
- <argument index="2" name="skew" type="float" />
- <argument index="3" name="position" type="Vector2" />
+ <param index="0" name="rotation" type="float" />
+ <param index="1" name="scale" type="Vector2" />
+ <param index="2" name="skew" type="float" />
+ <param index="3" name="position" type="Vector2" />
<description>
Constructs the transform from a given angle (in radians), scale, skew (in radians) and position.
</description>
</constructor>
<constructor name="Transform2D">
<return type="Transform2D" />
- <argument index="0" name="x_axis" type="Vector2" />
- <argument index="1" name="y_axis" type="Vector2" />
- <argument index="2" name="origin" type="Vector2" />
+ <param index="0" name="x_axis" type="Vector2" />
+ <param index="1" name="y_axis" type="Vector2" />
+ <param index="2" name="origin" type="Vector2" />
<description>
Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors).
</description>
@@ -64,7 +64,7 @@
</method>
<method name="basis_xform" qualifiers="const">
<return type="Vector2" />
- <argument index="0" name="v" type="Vector2" />
+ <param index="0" name="v" type="Vector2" />
<description>
Returns a vector transformed (multiplied) by the basis matrix.
This method does not account for translation (the origin vector).
@@ -72,7 +72,7 @@
</method>
<method name="basis_xform_inv" qualifiers="const">
<return type="Vector2" />
- <argument index="0" name="v" type="Vector2" />
+ <param index="0" name="v" type="Vector2" />
<description>
Returns a vector transformed (multiplied) by the inverse basis matrix.
This method does not account for translation (the origin vector).
@@ -104,8 +104,8 @@
</method>
<method name="interpolate_with" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="xform" type="Transform2D" />
- <argument index="1" name="weight" type="float" />
+ <param index="0" name="xform" type="Transform2D" />
+ <param index="1" name="weight" type="float" />
<description>
Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0).
</description>
@@ -118,14 +118,14 @@
</method>
<method name="is_equal_approx" qualifiers="const">
<return type="bool" />
- <argument index="0" name="xform" type="Transform2D" />
+ <param index="0" name="xform" type="Transform2D" />
<description>
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
</description>
</method>
<method name="looking_at" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="target" type="Vector2" default="Vector2(0, 0)" />
+ <param index="0" name="target" type="Vector2" default="Vector2(0, 0)" />
<description>
Returns a copy of the transform rotated such that it's rotation on the X-axis points towards the [code]target[/code] position.
Operations take place in global space.
@@ -139,7 +139,7 @@
</method>
<method name="rotated" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="angle" type="float" />
+ <param index="0" name="angle" type="float" />
<description>
Returns a copy of the transform rotated by the given [code]angle[/code] (in radians).
This method is an optimized version of multiplying the given transform [code]X[/code]
@@ -149,7 +149,7 @@
</method>
<method name="rotated_local" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="angle" type="float" />
+ <param index="0" name="angle" type="float" />
<description>
Returns a copy of the transform rotated by the given [code]angle[/code] (in radians).
This method is an optimized version of multiplying the given transform [code]X[/code]
@@ -159,7 +159,7 @@
</method>
<method name="scaled" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="scale" type="Vector2" />
+ <param index="0" name="scale" type="Vector2" />
<description>
Returns a copy of the transform scaled by the given [code]scale[/code] factor.
This method is an optimized version of multiplying the given transform [code]X[/code]
@@ -169,7 +169,7 @@
</method>
<method name="scaled_local" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="scale" type="Vector2" />
+ <param index="0" name="scale" type="Vector2" />
<description>
Returns a copy of the transform scaled by the given [code]scale[/code] factor.
This method is an optimized version of multiplying the given transform [code]X[/code]
@@ -179,14 +179,14 @@
</method>
<method name="set_rotation">
<return type="void" />
- <argument index="0" name="rotation" type="float" />
+ <param index="0" name="rotation" type="float" />
<description>
Sets the transform's rotation (in radians).
</description>
</method>
<method name="set_scale">
<return type="void" />
- <argument index="0" name="scale" type="Vector2" />
+ <param index="0" name="scale" type="Vector2" />
<description>
Sets the transform's scale.
[b]Note:[/b] Negative X scales in 2D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, negative scales on the X axis will be changed to negative scales on the Y axis and a rotation of 180 degrees when decomposed.
@@ -194,14 +194,14 @@
</method>
<method name="set_skew">
<return type="void" />
- <argument index="0" name="skew" type="float" />
+ <param index="0" name="skew" type="float" />
<description>
Sets the transform's skew (in radians).
</description>
</method>
<method name="translated" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="offset" type="Vector2" />
+ <param index="0" name="offset" type="Vector2" />
<description>
Returns a copy of the transform translated by the given [code]offset[/code].
This method is an optimized version of multiplying the given transform [code]X[/code]
@@ -211,7 +211,7 @@
</method>
<method name="translated_local" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="offset" type="Vector2" />
+ <param index="0" name="offset" type="Vector2" />
<description>
Returns a copy of the transform translated by the given [code]offset[/code].
This method is an optimized version of multiplying the given transform [code]X[/code]
@@ -245,7 +245,7 @@
<operators>
<operator name="operator !=">
<return type="bool" />
- <argument index="0" name="right" type="Transform2D" />
+ <param index="0" name="right" type="Transform2D" />
<description>
Returns [code]true[/code] if the transforms are not equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
@@ -253,49 +253,49 @@
</operator>
<operator name="operator *">
<return type="PackedVector2Array" />
- <argument index="0" name="right" type="PackedVector2Array" />
+ <param index="0" name="right" type="PackedVector2Array" />
<description>
Transforms (multiplies) each element of the [Vector2] array by the given [Transform2D] matrix.
</description>
</operator>
<operator name="operator *">
<return type="Rect2" />
- <argument index="0" name="right" type="Rect2" />
+ <param index="0" name="right" type="Rect2" />
<description>
Transforms (multiplies) the [Rect2] by the given [Transform2D] matrix.
</description>
</operator>
<operator name="operator *">
<return type="Transform2D" />
- <argument index="0" name="right" type="Transform2D" />
+ <param index="0" name="right" type="Transform2D" />
<description>
Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent).
</description>
</operator>
<operator name="operator *">
<return type="Vector2" />
- <argument index="0" name="right" type="Vector2" />
+ <param index="0" name="right" type="Vector2" />
<description>
Transforms (multiplies) the [Vector2] by the given [Transform2D] matrix.
</description>
</operator>
<operator name="operator *">
<return type="Transform2D" />
- <argument index="0" name="right" type="float" />
+ <param index="0" name="right" type="float" />
<description>
This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly.
</description>
</operator>
<operator name="operator *">
<return type="Transform2D" />
- <argument index="0" name="right" type="int" />
+ <param index="0" name="right" type="int" />
<description>
This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly.
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
- <argument index="0" name="right" type="Transform2D" />
+ <param index="0" name="right" type="Transform2D" />
<description>
Returns [code]true[/code] if the transforms are exactly equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
@@ -303,7 +303,7 @@
</operator>
<operator name="operator []">
<return type="Vector2" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
Access transform components using their index. [code]t[0][/code] is equivalent to [code]t.x[/code], [code]t[1][/code] is equivalent to [code]t.y[/code], and [code]t[2][/code] is equivalent to [code]t.origin[/code].
</description>