diff options
Diffstat (limited to 'doc/classes/Vector3i.xml')
| -rw-r--r-- | doc/classes/Vector3i.xml | 203 |
1 files changed, 86 insertions, 117 deletions
diff --git a/doc/classes/Vector3i.xml b/doc/classes/Vector3i.xml index a1ae2aceab..bc3712ba3e 100644 --- a/doc/classes/Vector3i.xml +++ b/doc/classes/Vector3i.xml @@ -15,214 +15,183 @@ </tutorials> <methods> <method name="Vector3i" qualifiers="constructor"> - <return type="Vector3i"> - </return> + <return type="Vector3i" /> <description> Constructs a default-initialized [Vector3i] with all components set to [code]0[/code]. </description> </method> <method name="Vector3i" qualifiers="constructor"> - <return type="Vector3i"> - </return> - <argument index="0" name="from" type="Vector3i"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="from" type="Vector3i" /> <description> Constructs a [Vector3i] as a copy of the given [Vector3i]. </description> </method> <method name="Vector3i" qualifiers="constructor"> - <return type="Vector3i"> - </return> - <argument index="0" name="from" type="Vector3"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="from" type="Vector3" /> <description> Constructs a new [Vector3i] from [Vector3]. The floating point coordinates will be truncated. </description> </method> <method name="Vector3i" qualifiers="constructor"> - <return type="Vector3i"> - </return> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> - <argument index="2" name="z" type="int"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="x" type="int" /> + <argument index="1" name="y" type="int" /> + <argument index="2" name="z" type="int" /> <description> Returns a [Vector3i] with the given components. </description> </method> - <method name="abs"> - <return type="Vector3i"> - </return> + <method name="abs" qualifiers="const"> + <return type="Vector3i" /> <description> </description> </method> - <method name="max_axis"> - <return type="int"> - </return> + <method name="clamp" qualifiers="const"> + <return type="Vector3i" /> + <argument index="0" name="min" type="Vector3i" /> + <argument index="1" name="max" type="Vector3i" /> + <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="max_axis" qualifiers="const"> + <return type="int" /> <description> Returns the axis of the vector's largest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_X]. </description> </method> - <method name="min_axis"> - <return type="int"> - </return> + <method name="min_axis" qualifiers="const"> + <return type="int" /> <description> Returns the axis of the vector's smallest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_Z]. </description> </method> <method name="operator !=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <return type="bool" /> <description> </description> </method> - <method name="operator %" qualifiers="operator"> - <return type="Vector3i"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <method name="operator !=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="Vector3i" /> <description> </description> </method> <method name="operator %" qualifiers="operator"> - <return type="Vector3i"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="right" type="Vector3i" /> <description> </description> </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3i"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <method name="operator %" qualifiers="operator"> + <return type="Vector3i" /> + <argument index="0" name="right" type="int" /> <description> </description> </method> <method name="operator *" qualifiers="operator"> - <return type="Vector3i"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="right" type="Vector3i" /> <description> </description> </method> <method name="operator *" qualifiers="operator"> - <return type="Vector3i"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="right" type="float" /> <description> </description> </method> - <method name="operator +" qualifiers="operator"> - <return type="Vector3i"> - </return> + <method name="operator *" qualifiers="operator"> + <return type="Vector3i" /> + <argument index="0" name="right" type="int" /> <description> </description> </method> <method name="operator +" qualifiers="operator"> - <return type="Vector3i"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="right" type="Vector3i" /> <description> </description> </method> <method name="operator -" qualifiers="operator"> - <return type="Vector3i"> - </return> - <description> - </description> - </method> - <method name="operator -" qualifiers="operator"> - <return type="Vector3i"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="right" type="Vector3i" /> <description> </description> </method> <method name="operator /" qualifiers="operator"> - <return type="Vector3i"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="right" type="Vector3i" /> <description> </description> </method> <method name="operator /" qualifiers="operator"> - <return type="Vector3i"> - </return> - <argument index="0" name="right" type="float"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="right" type="float" /> <description> </description> </method> <method name="operator /" qualifiers="operator"> - <return type="Vector3i"> - </return> - <argument index="0" name="right" type="int"> - </argument> + <return type="Vector3i" /> + <argument index="0" name="right" type="int" /> <description> </description> </method> <method name="operator <" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="Vector3i" /> <description> </description> </method> <method name="operator <=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="Vector3i" /> + <description> + </description> + </method> + <method name="operator ==" qualifiers="operator"> + <return type="bool" /> <description> </description> </method> <method name="operator ==" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="Vector3i" /> <description> </description> </method> <method name="operator >" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="Vector3i" /> <description> </description> </method> <method name="operator >=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="Vector3i"> - </argument> + <return type="bool" /> + <argument index="0" name="right" type="Vector3i" /> <description> </description> </method> <method name="operator []" qualifiers="operator"> - <return type="int"> - </return> - <argument index="0" name="index" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </method> + <method name="operator unary+" qualifiers="operator"> + <return type="Vector3i" /> + <description> + </description> + </method> + <method name="operator unary-" qualifiers="operator"> + <return type="Vector3i" /> <description> </description> </method> - <method name="sign"> - <return type="Vector3i"> - </return> + <method name="sign" qualifiers="const"> + <return type="Vector3i" /> <description> Returns the vector with each component set to one or negative one, depending on the signs of the components. </description> @@ -249,28 +218,28 @@ <constant name="AXIS_Z" value="2"> Enumerated value for the Z axis. </constant> - <constant name="ZERO" value="Vector3i( 0, 0, 0 )"> + <constant name="ZERO" value="Vector3i(0, 0, 0)"> Zero vector, a vector with all components set to [code]0[/code]. </constant> - <constant name="ONE" value="Vector3i( 1, 1, 1 )"> + <constant name="ONE" value="Vector3i(1, 1, 1)"> One vector, a vector with all components set to [code]1[/code]. </constant> - <constant name="LEFT" value="Vector3i( -1, 0, 0 )"> + <constant name="LEFT" value="Vector3i(-1, 0, 0)"> Left unit vector. Represents the local direction of left, and the global direction of west. </constant> - <constant name="RIGHT" value="Vector3i( 1, 0, 0 )"> + <constant name="RIGHT" value="Vector3i(1, 0, 0)"> Right unit vector. Represents the local direction of right, and the global direction of east. </constant> - <constant name="UP" value="Vector3i( 0, 1, 0 )"> + <constant name="UP" value="Vector3i(0, 1, 0)"> Up unit vector. </constant> - <constant name="DOWN" value="Vector3i( 0, -1, 0 )"> + <constant name="DOWN" value="Vector3i(0, -1, 0)"> Down unit vector. </constant> - <constant name="FORWARD" value="Vector3i( 0, 0, -1 )"> + <constant name="FORWARD" value="Vector3i(0, 0, -1)"> Forward unit vector. Represents the local direction of forward, and the global direction of north. </constant> - <constant name="BACK" value="Vector3i( 0, 0, 1 )"> + <constant name="BACK" value="Vector3i(0, 0, 1)"> Back unit vector. Represents the local direction of back, and the global direction of south. </constant> </constants> |