diff options
Diffstat (limited to 'doc/classes/Vector2i.xml')
| -rw-r--r-- | doc/classes/Vector2i.xml | 181 |
1 files changed, 153 insertions, 28 deletions
diff --git a/doc/classes/Vector2i.xml b/doc/classes/Vector2i.xml index 75ddc46dab..212b1fd22b 100644 --- a/doc/classes/Vector2i.xml +++ b/doc/classes/Vector2i.xml @@ -14,43 +14,168 @@ <link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link> </tutorials> <methods> - <method name="Vector2i"> - <return type="Vector2i"> - </return> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> + <method name="Vector2i" qualifiers="constructor"> + <return type="Vector2i" /> <description> - Constructs a new [Vector2i] from the given [code]x[/code] and [code]y[/code]. + Constructs a default-initialized [Vector2i] with all components set to [code]0[/code]. </description> </method> - <method name="Vector2i"> - <return type="Vector2i"> - </return> - <argument index="0" name="from" type="Vector2"> - </argument> + <method name="Vector2i" qualifiers="constructor"> + <return type="Vector2i" /> + <argument index="0" name="from" type="Vector2i" /> + <description> + Constructs a [Vector2i] as a copy of the given [Vector2i]. + </description> + </method> + <method name="Vector2i" qualifiers="constructor"> + <return type="Vector2i" /> + <argument index="0" name="from" type="Vector2" /> <description> Constructs a new [Vector2i] from [Vector2]. The floating point coordinates will be truncated. </description> </method> - <method name="abs"> - <return type="Vector2i"> - </return> + <method name="Vector2i" qualifiers="constructor"> + <return type="Vector2i" /> + <argument index="0" name="x" type="int" /> + <argument index="1" name="y" type="int" /> + <description> + Constructs a new [Vector2i] from the given [code]x[/code] and [code]y[/code]. + </description> + </method> + <method name="abs" qualifiers="const"> + <return type="Vector2i" /> <description> Returns a new vector with all components in absolute values (i.e. positive). </description> </method> - <method name="aspect"> - <return type="float"> - </return> + <method name="aspect" qualifiers="const"> + <return type="float" /> <description> Returns the ratio of [member x] to [member y]. </description> </method> - <method name="sign"> - <return type="Vector2i"> - </return> + <method name="clamp" qualifiers="const"> + <return type="Vector2i" /> + <argument index="0" name="min" type="Vector2i" /> + <argument index="1" name="max" type="Vector2i" /> + <description> + Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. + </description> + </method> + <method name="operator !=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + </description> + </method> + <method name="operator %" qualifiers="operator"> + <return type="Vector2i" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + </description> + </method> + <method name="operator %" qualifiers="operator"> + <return type="Vector2i" /> + <argument index="0" name="right" type="int" /> + <description> + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="Vector2i" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="Vector2i" /> + <argument index="0" name="right" type="float" /> + <description> + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="Vector2i" /> + <argument index="0" name="right" type="int" /> + <description> + </description> + </method> + <method name="operator +" qualifiers="operator"> + <return type="Vector2i" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + </description> + </method> + <method name="operator -" qualifiers="operator"> + <return type="Vector2i" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + </description> + </method> + <method name="operator /" qualifiers="operator"> + <return type="Vector2i" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + </description> + </method> + <method name="operator /" qualifiers="operator"> + <return type="Vector2i" /> + <argument index="0" name="right" type="float" /> + <description> + </description> + </method> + <method name="operator /" qualifiers="operator"> + <return type="Vector2i" /> + <argument index="0" name="right" type="int" /> + <description> + </description> + </method> + <method name="operator <" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + </description> + </method> + <method name="operator <=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + </description> + </method> + <method name="operator ==" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + </description> + </method> + <method name="operator >" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + </description> + </method> + <method name="operator >=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + </description> + </method> + <method name="operator []" qualifiers="operator"> + <return type="int" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </method> + <method name="operator unary+" qualifiers="operator"> + <return type="Vector2i" /> + <description> + </description> + </method> + <method name="operator unary-" qualifiers="operator"> + <return type="Vector2i" /> + <description> + </description> + </method> + <method name="sign" qualifiers="const"> + <return type="Vector2i" /> <description> Returns the vector with each component set to one or negative one, depending on the signs of the components. </description> @@ -71,22 +196,22 @@ <constant name="AXIS_Y" value="1"> Enumerated value for the Y axis. </constant> - <constant name="ZERO" value="Vector2i( 0, 0 )"> + <constant name="ZERO" value="Vector2i(0, 0)"> Zero vector, a vector with all components set to [code]0[/code]. </constant> - <constant name="ONE" value="Vector2i( 1, 1 )"> + <constant name="ONE" value="Vector2i(1, 1)"> One vector, a vector with all components set to [code]1[/code]. </constant> - <constant name="LEFT" value="Vector2i( -1, 0 )"> + <constant name="LEFT" value="Vector2i(-1, 0)"> Left unit vector. Represents the direction of left. </constant> - <constant name="RIGHT" value="Vector2i( 1, 0 )"> + <constant name="RIGHT" value="Vector2i(1, 0)"> Right unit vector. Represents the direction of right. </constant> - <constant name="UP" value="Vector2i( 0, -1 )"> + <constant name="UP" value="Vector2i(0, -1)"> Up unit vector. Y is down in 2D, so this vector points -Y. </constant> - <constant name="DOWN" value="Vector2i( 0, 1 )"> + <constant name="DOWN" value="Vector2i(0, 1)"> Down unit vector. Y is down in 2D, so this vector points +Y. </constant> </constants> |