summaryrefslogtreecommitdiff
path: root/doc/classes/Rect2i.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Rect2i.xml')
-rw-r--r--doc/classes/Rect2i.xml67
1 files changed, 33 insertions, 34 deletions
diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml
index c9ae685a15..80a9b40605 100644
--- a/doc/classes/Rect2i.xml
+++ b/doc/classes/Rect2i.xml
@@ -21,32 +21,32 @@
</constructor>
<constructor name="Rect2i">
<return type="Rect2i" />
- <argument index="0" name="from" type="Rect2i" />
+ <param index="0" name="from" type="Rect2i" />
<description>
Constructs a [Rect2i] as a copy of the given [Rect2i].
</description>
</constructor>
<constructor name="Rect2i">
<return type="Rect2i" />
- <argument index="0" name="from" type="Rect2" />
+ <param index="0" name="from" type="Rect2" />
<description>
Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated.
</description>
</constructor>
<constructor name="Rect2i">
<return type="Rect2i" />
- <argument index="0" name="position" type="Vector2i" />
- <argument index="1" name="size" type="Vector2i" />
+ <param index="0" name="position" type="Vector2i" />
+ <param index="1" name="size" type="Vector2i" />
<description>
Constructs a [Rect2i] by position and size.
</description>
</constructor>
<constructor name="Rect2i">
<return type="Rect2i" />
- <argument index="0" name="x" type="int" />
- <argument index="1" name="y" type="int" />
- <argument index="2" name="width" type="int" />
- <argument index="3" name="height" type="int" />
+ <param index="0" name="x" type="int" />
+ <param index="1" name="y" type="int" />
+ <param index="2" name="width" type="int" />
+ <param index="3" name="height" type="int" />
<description>
Constructs a [Rect2i] by x, y, width, and height.
</description>
@@ -61,14 +61,14 @@
</method>
<method name="encloses" qualifiers="const">
<return type="bool" />
- <argument index="0" name="b" type="Rect2i" />
+ <param index="0" name="b" type="Rect2i" />
<description>
Returns [code]true[/code] if this [Rect2i] completely encloses another one.
</description>
</method>
<method name="expand" qualifiers="const">
<return type="Rect2i" />
- <argument index="0" name="to" type="Vector2i" />
+ <param index="0" name="to" type="Vector2i" />
<description>
Returns a copy of this [Rect2i] expanded so that the borders align with the given point.
[codeblocks]
@@ -79,10 +79,10 @@
var rect2 = rect.expand(Vector2i(0, -1))
[/gdscript]
[csharp]
- # position (-3, 2), size (1, 1)
- var rect = new Rect2i(new Vector2i(-3, 2), new Vector2i(1, 1));
- # position (-3, -1), size (3, 4), so we fit both rect and Vector2i(0, -1)
- var rect2 = rect.Expand(new Vector2i(0, -1));
+ // position (-3, 2), size (1, 1)
+ var rect = new Rect2I(new Vector2I(-3, 2), new Vector2I(1, 1));
+ // position (-3, -1), size (3, 4), so we fit both rect and Vector2I(0, -1)
+ var rect2 = rect.Expand(new Vector2I(0, -1));
[/csharp]
[/codeblocks]
</description>
@@ -90,7 +90,7 @@
<method name="get_area" qualifiers="const">
<return type="int" />
<description>
- Returns the area of the [Rect2i]. See also [method has_no_area].
+ Returns the area of the [Rect2i]. See also [method has_area].
</description>
</method>
<method name="get_center" qualifiers="const">
@@ -102,39 +102,38 @@
</method>
<method name="grow" qualifiers="const">
<return type="Rect2i" />
- <argument index="0" name="amount" type="int" />
+ <param index="0" name="amount" type="int" />
<description>
- Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on all sides.
+ Returns a copy of the [Rect2i] grown by the specified [param amount] on all sides.
</description>
</method>
<method name="grow_individual" qualifiers="const">
<return type="Rect2i" />
- <argument index="0" name="left" type="int" />
- <argument index="1" name="top" type="int" />
- <argument index="2" name="right" type="int" />
- <argument index="3" name="bottom" type="int" />
+ <param index="0" name="left" type="int" />
+ <param index="1" name="top" type="int" />
+ <param index="2" name="right" type="int" />
+ <param index="3" name="bottom" type="int" />
<description>
Returns a copy of the [Rect2i] grown by the specified amount on each side individually.
</description>
</method>
<method name="grow_side" qualifiers="const">
<return type="Rect2i" />
- <argument index="0" name="side" type="int" />
- <argument index="1" name="amount" type="int" />
+ <param index="0" name="side" type="int" />
+ <param index="1" name="amount" type="int" />
<description>
- Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on the specified [enum Side].
+ Returns a copy of the [Rect2i] grown by the specified [param amount] on the specified [enum Side].
</description>
</method>
- <method name="has_no_area" qualifiers="const">
+ <method name="has_area" qualifiers="const">
<return type="bool" />
<description>
- Returns [code]true[/code] if the [Rect2i] is flat or empty, [code]false[/code] otherwise. See also [method get_area].
- [b]Note:[/b] If the [Rect2i] has a negative size and is not flat or empty, [method has_no_area] will return [code]true[/code].
+ Returns [code]true[/code] if the [Rect2i] has area, and [code]false[/code] if the [Rect2i] is linear, empty, or has a negative [member size]. See also [method get_area].
</description>
</method>
<method name="has_point" qualifiers="const">
<return type="bool" />
- <argument index="0" name="point" type="Vector2i" />
+ <param index="0" name="point" type="Vector2i" />
<description>
Returns [code]true[/code] if the [Rect2i] contains a point. By convention, the right and bottom edges of the [Rect2i] are considered exclusive, so points on these edges are [b]not[/b] included.
[b]Note:[/b] This method is not reliable for [Rect2i] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent rectangle to check for contained points.
@@ -142,7 +141,7 @@
</method>
<method name="intersection" qualifiers="const">
<return type="Rect2i" />
- <argument index="0" name="b" type="Rect2i" />
+ <param index="0" name="b" type="Rect2i" />
<description>
Returns the intersection of this [Rect2i] and [code]b[/code].
If the rectangles do not intersect, an empty [Rect2i] is returned.
@@ -150,16 +149,16 @@
</method>
<method name="intersects" qualifiers="const">
<return type="bool" />
- <argument index="0" name="b" type="Rect2i" />
+ <param index="0" name="b" type="Rect2i" />
<description>
Returns [code]true[/code] if the [Rect2i] overlaps with [code]b[/code] (i.e. they have at least one point in common).
</description>
</method>
<method name="merge" qualifiers="const">
<return type="Rect2i" />
- <argument index="0" name="b" type="Rect2i" />
+ <param index="0" name="b" type="Rect2i" />
<description>
- Returns a larger [Rect2i] that contains this [Rect2i] and [code]b[/code].
+ Returns a larger [Rect2i] that contains this [Rect2i] and [param b].
</description>
</method>
</methods>
@@ -178,14 +177,14 @@
<operators>
<operator name="operator !=">
<return type="bool" />
- <argument index="0" name="right" type="Rect2i" />
+ <param index="0" name="right" type="Rect2i" />
<description>
Returns [code]true[/code] if the rectangles are not equal.
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
- <argument index="0" name="right" type="Rect2i" />
+ <param index="0" name="right" type="Rect2i" />
<description>
Returns [code]true[/code] if the rectangles are equal.
</description>
generated by cgit v1.2.3 (git 2.25.1) at 2025-01-24 10:05:46 +0000