summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Array.xml2
-rw-r--r--doc/classes/Dictionary.xml2
-rw-r--r--doc/classes/PackedByteArray.xml2
-rw-r--r--doc/classes/PackedColorArray.xml2
-rw-r--r--doc/classes/PackedFloat32Array.xml2
-rw-r--r--doc/classes/PackedFloat64Array.xml2
-rw-r--r--doc/classes/PackedInt32Array.xml2
-rw-r--r--doc/classes/PackedInt64Array.xml2
-rw-r--r--doc/classes/PackedStringArray.xml2
-rw-r--r--doc/classes/PackedVector2Array.xml2
-rw-r--r--doc/classes/PackedVector3Array.xml2
-rw-r--r--doc/classes/Rect2.xml3
-rw-r--r--doc/classes/Rect2i.xml3
-rw-r--r--doc/classes/SceneTree.xml2
-rw-r--r--doc/classes/String.xml2
15 files changed, 18 insertions, 14 deletions
diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml
index 6a9eb89602..e4f9dcf993 100644
--- a/doc/classes/Array.xml
+++ b/doc/classes/Array.xml
@@ -228,7 +228,7 @@
If [code]deep[/code] is [code]true[/code], a deep copy is performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If [code]false[/code], a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml
index cd0b5ac027..2ca705cec7 100644
--- a/doc/classes/Dictionary.xml
+++ b/doc/classes/Dictionary.xml
@@ -215,7 +215,7 @@
Creates a copy of the dictionary, and returns it. The [code]deep[/code] parameter causes inner dictionaries and arrays to be copied recursively, but does not apply to objects.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml
index 0cef26df79..b00c59ade9 100644
--- a/doc/classes/PackedByteArray.xml
+++ b/doc/classes/PackedByteArray.xml
@@ -92,7 +92,7 @@
Creates a copy of the array, and returns it.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml
index b45e2cbe2e..d6cd5196e4 100644
--- a/doc/classes/PackedColorArray.xml
+++ b/doc/classes/PackedColorArray.xml
@@ -59,7 +59,7 @@
Creates a copy of the array, and returns it.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml
index d6825dbcd7..52f6ece158 100644
--- a/doc/classes/PackedFloat32Array.xml
+++ b/doc/classes/PackedFloat32Array.xml
@@ -60,7 +60,7 @@
Creates a copy of the array, and returns it.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
diff --git a/doc/classes/PackedFloat64Array.xml b/doc/classes/PackedFloat64Array.xml
index 9b6df93cf5..2f317d4b8c 100644
--- a/doc/classes/PackedFloat64Array.xml
+++ b/doc/classes/PackedFloat64Array.xml
@@ -60,7 +60,7 @@
Creates a copy of the array, and returns it.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
diff --git a/doc/classes/PackedInt32Array.xml b/doc/classes/PackedInt32Array.xml
index 7923b268a4..bda902b15f 100644
--- a/doc/classes/PackedInt32Array.xml
+++ b/doc/classes/PackedInt32Array.xml
@@ -60,7 +60,7 @@
Creates a copy of the array, and returns it.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
diff --git a/doc/classes/PackedInt64Array.xml b/doc/classes/PackedInt64Array.xml
index f7e9128410..9c52ec808b 100644
--- a/doc/classes/PackedInt64Array.xml
+++ b/doc/classes/PackedInt64Array.xml
@@ -60,7 +60,7 @@
Creates a copy of the array, and returns it.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml
index 1ae0d55177..24406c53d4 100644
--- a/doc/classes/PackedStringArray.xml
+++ b/doc/classes/PackedStringArray.xml
@@ -60,7 +60,7 @@
Creates a copy of the array, and returns it.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml
index 9ab3a03edb..2f583e2b9b 100644
--- a/doc/classes/PackedVector2Array.xml
+++ b/doc/classes/PackedVector2Array.xml
@@ -60,7 +60,7 @@
Creates a copy of the array, and returns it.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml
index 80787547ac..6004454dc9 100644
--- a/doc/classes/PackedVector3Array.xml
+++ b/doc/classes/PackedVector3Array.xml
@@ -59,7 +59,7 @@
Creates a copy of the array, and returns it.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml
index 8feeb91b97..34f81948c4 100644
--- a/doc/classes/Rect2.xml
+++ b/doc/classes/Rect2.xml
@@ -78,7 +78,8 @@
<argument index="0" name="b" type="Rect2">
</argument>
<description>
- Returns the intersection of this [Rect2] and b.
+ Returns the intersection of this [Rect2] and [code]b[/code].
+ If the rectangles do not intersect, an empty [Rect2] is returned.
</description>
</method>
<method name="encloses">
diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml
index 80f2a87f31..d354adf892 100644
--- a/doc/classes/Rect2i.xml
+++ b/doc/classes/Rect2i.xml
@@ -76,7 +76,8 @@
<argument index="0" name="b" type="Rect2i">
</argument>
<description>
- Returns the intersection of this [Rect2i] and b.
+ Returns the intersection of this [Rect2i] and [code]b[/code].
+ If the rectangles do not intersect, an empty [Rect2i] is returned.
</description>
</method>
<method name="encloses">
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml
index a95ce6c663..5fc1d0b895 100644
--- a/doc/classes/SceneTree.xml
+++ b/doc/classes/SceneTree.xml
@@ -45,6 +45,7 @@
<description>
Changes the running scene to the one at the given [code]path[/code], after loading it into a [PackedScene] and creating a new instance.
Returns [constant OK] on success, [constant ERR_CANT_OPEN] if the [code]path[/code] cannot be loaded into a [PackedScene], or [constant ERR_CANT_CREATE] if that scene cannot be instantiated.
+ [b]Note:[/b] The scene change is deferred, which means that the new scene node is added on the next idle frame. You won't be able to access it immediately after the [method change_scene] call.
</description>
</method>
<method name="change_scene_to">
@@ -55,6 +56,7 @@
<description>
Changes the running scene to a new instance of the given [PackedScene].
Returns [constant OK] on success or [constant ERR_CANT_CREATE] if the scene cannot be instantiated.
+ [b]Note:[/b] The scene change is deferred, which means that the new scene node is added on the next idle frame. You won't be able to access it immediately after the [method change_scene_to] call.
</description>
</method>
<method name="create_timer">
diff --git a/doc/classes/String.xml b/doc/classes/String.xml
index 4ee9dbf1f9..cbaf1196e3 100644
--- a/doc/classes/String.xml
+++ b/doc/classes/String.xml
@@ -135,7 +135,7 @@
Returns a copy of the string with indentation (leading tabs and spaces) removed.
</description>
</method>
- <method name="empty">
+ <method name="is_empty">
<return type="bool">
</return>
<description>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-19 12:04:48 +0000