summaryrefslogtreecommitdiff
path: root/doc/classes/Vector2i.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-06-03 15:12:39 +0200
committerGitHub <noreply@github.com>2020-06-03 15:12:39 +0200
commitdc67d0737b86c7a6cab66752b96631c59c703997 (patch)
treed834e4b197426c3518a6977dca07ffe47dbb981a /doc/classes/Vector2i.xml
parent4db1f1602cd7fd003c090e43714d7418a53db50f (diff)
parentd7cf1b5c7371c64059298bcf711f1ac6353222fe (diff)
Merge pull request #39257 from Chaosus/fix_integer_vectors_doc
Fix docs generation for Vector2i/Vector3i/Rect2i
Diffstat (limited to 'doc/classes/Vector2i.xml')
-rw-r--r--doc/classes/Vector2i.xml29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/classes/Vector2i.xml b/doc/classes/Vector2i.xml
index a516eb01dd..71c7aaa4e5 100644
--- a/doc/classes/Vector2i.xml
+++ b/doc/classes/Vector2i.xml
@@ -31,7 +31,36 @@
Constructs a new [Vector2i] from [Vector2]. The floating point coordinates will be truncated.
</description>
</method>
+ <method name="abs">
+ <return type="Vector2i">
+ </return>
+ <description>
+ Returns a new vector with all components in absolute values (i.e. positive).
+ </description>
+ </method>
+ <method name="aspect">
+ <return type="float">
+ </return>
+ <description>
+ Returns the ratio of [member x] to [member y].
+ </description>
+ </method>
+ <method name="sign">
+ <return type="Vector2i">
+ </return>
+ <description>
+ Returns the vector with each component set to one or negative one, depending on the signs of the components.
+ </description>
+ </method>
</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.