summaryrefslogtreecommitdiffstats
path: root/doc/classes/Vector2.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-05-02 14:01:09 +0200
committerRémi Verschelde <rverschelde@gmail.com>2024-05-02 14:01:09 +0200
commit396ce1a8c8a69a8a1448fcc9321bf055ae9fb5f1 (patch)
treec5d890d4d5e9fbe516b38e47caf9fdbd676b3293 /doc/classes/Vector2.xml
parenta0b0b19043ca670940049e88e73a965aa9c8d721 (diff)
parent0f5e0d1637cc401f353fd4692c1279a87972bc85 (diff)
downloadredot-engine-396ce1a8c8a69a8a1448fcc9321bf055ae9fb5f1.tar.gz
Merge pull request #80223 from AThousandShips/vec_elem
Expose `Vector*` component-wise and scalar `min/max` to scripting
Diffstat (limited to 'doc/classes/Vector2.xml')
-rw-r--r--doc/classes/Vector2.xml28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml
index 961a60060a..5fadfd0d95 100644
--- a/doc/classes/Vector2.xml
+++ b/doc/classes/Vector2.xml
@@ -273,18 +273,46 @@
Returns the vector with a maximum length by limiting its length to [param length].
</description>
</method>
+ <method name="max" qualifiers="const">
+ <return type="Vector2" />
+ <param index="0" name="with" type="Vector2" />
+ <description>
+ Returns the component-wise maximum of this and [param with], equivalent to [code]Vector2(maxf(x, with.x), maxf(y, with.y))[/code].
+ </description>
+ </method>
<method name="max_axis_index" qualifiers="const">
<return type="int" />
<description>
Returns the axis of the vector's highest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_X].
</description>
</method>
+ <method name="maxf" qualifiers="const">
+ <return type="Vector2" />
+ <param index="0" name="with" type="float" />
+ <description>
+ Returns the component-wise maximum of this and [param with], equivalent to [code]Vector2(maxf(x, with), maxf(y, with))[/code].
+ </description>
+ </method>
+ <method name="min" qualifiers="const">
+ <return type="Vector2" />
+ <param index="0" name="with" type="Vector2" />
+ <description>
+ Returns the component-wise minimum of this and [param with], equivalent to [code]Vector2(minf(x, with.x), minf(y, with.y))[/code].
+ </description>
+ </method>
<method name="min_axis_index" qualifiers="const">
<return type="int" />
<description>
Returns the axis of the vector's lowest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_Y].
</description>
</method>
+ <method name="minf" qualifiers="const">
+ <return type="Vector2" />
+ <param index="0" name="with" type="float" />
+ <description>
+ Returns the component-wise minimum of this and [param with], equivalent to [code]Vector2(minf(x, with), minf(y, with))[/code].
+ </description>
+ </method>
<method name="move_toward" qualifiers="const">
<return type="Vector2" />
<param index="0" name="to" type="Vector2" />