godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
d975b1bc37
godot/doc/classes/Vector2i.xml

233 lines
7.4 KiB
XML
Raw Normal View History

Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Vector2i" version="4.0">
<brief_description>
Vector used for 2D math using integer coordinates.
</brief_description>
<description>
2-element structure that can be used to represent positions in 2D space or any other pair of numeric values.
Document how Vector2, Vector3 and Color behave in a boolean context See #39731.
2020-06-21 15:16:10 +00:00
It uses integer coordinates and is therefore preferable to [Vector2] when exact precision is required.
[b]Note:[/b] In a boolean context, a Vector2i will evaluate to [code]false[/code] if it's equal to [code]Vector2i(0, 0)[/code]. Otherwise, a Vector2i will always evaluate to [code]true[/code].
Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
</description>
<tutorials>
doc: Update links to latest documentation after content reorganization
2021-10-06 11:48:48 +00:00
<link title="Math documentation index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
Link to demos from within the class reference
2020-10-01 08:34:47 +00:00
<link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link>
<link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link>
Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
</tutorials>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<constructors>
<constructor name="Vector2i">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<description>
Constructs a default-initialized [Vector2i] with all components set to [code]0[/code].
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
<constructor name="Vector2i">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="from" type="Vector2i" />
Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
<description>
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
Constructs a [Vector2i] as a copy of the given [Vector2i].
Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
<constructor name="Vector2i">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="from" type="Vector2" />
Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
<description>
Constructs a new [Vector2i] from [Vector2]. The floating point coordinates will be truncated.
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
<constructor name="Vector2i">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="x" type="int" />
<argument index="1" name="y" type="int" />
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<description>
Constructs a new [Vector2i] from the given [code]x[/code] and [code]y[/code].
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
</constructors>
<methods>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="abs" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<description>
Returns a new vector with all components in absolute values (i.e. positive).
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="aspect" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<description>
Returns the ratio of [member x] to [member y].
</description>
</method>
Allow clamping vectors and colors
2021-02-01 05:10:52 +00:00
<method name="clamp" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="min" type="Vector2i" />
<argument index="1" name="max" type="Vector2i" />
Allow clamping vectors and colors
2021-02-01 05:10:52 +00:00
<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>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<method name="sign" qualifiers="const">
<return type="Vector2i" />
Allow comparing equality between builtin types and null
2021-09-17 15:22:48 +00:00
<description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
Returns the vector with each component set to one or negative one, depending on the signs of the components.
Allow comparing equality between builtin types and null
2021-09-17 15:22:48 +00:00
</description>
</method>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</methods>
<members>
<member name="x" type="int" setter="" getter="" default="0">
The vector's X component. Also accessible by using the index position [code][0][/code].
</member>
<member name="y" type="int" setter="" getter="" default="0">
The vector's Y component. Also accessible by using the index position [code][1][/code].
</member>
</members>
<constants>
<constant name="AXIS_X" value="0">
Enumerated value for the X axis.
</constant>
<constant name="AXIS_Y" value="1">
Enumerated value for the Y axis.
</constant>
<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)">
One vector, a vector with all components set to [code]1[/code].
</constant>
<constant name="LEFT" value="Vector2i(-1, 0)">
Left unit vector. Represents the direction of left.
</constant>
<constant name="RIGHT" value="Vector2i(1, 0)">
Right unit vector. Represents the direction of right.
</constant>
<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)">
Down unit vector. Y is down in 2D, so this vector points +Y.
</constant>
</constants>
<operators>
<operator name="operator !=">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator !=">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator %">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator %">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="right" type="int" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator *">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator *">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="right" type="float" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator *">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="right" type="int" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator +">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator -">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator /">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="right" type="Vector2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator /">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="right" type="float" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator /">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="right" type="int" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator &lt;">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator &lt;=">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator ==">
Allow comparing equality between builtin types and null
2021-09-17 15:22:48 +00:00
<return type="bool" />
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator ==">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator &gt;">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator &gt;=">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="Vector2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator []">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="index" type="int" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator unary+">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h
2021-06-19 15:58:49 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator unary-">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h
2021-06-19 15:58:49 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
</operators>
Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
</class>
Reference in New Issue Copy Permalink