summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Array.xml4
-rw-r--r--doc/classes/BitMap.xml1
-rw-r--r--doc/classes/Engine.xml2
-rw-r--r--doc/classes/Gradient.xml4
-rw-r--r--doc/classes/HSlider.xml1
-rw-r--r--doc/classes/JSON.xml22
-rw-r--r--doc/classes/Node.xml3
-rw-r--r--doc/classes/ProjectSettings.xml4
-rw-r--r--doc/classes/Slider.xml1
-rw-r--r--doc/classes/TextEdit.xml3
-rw-r--r--doc/classes/VSlider.xml1
-rw-r--r--doc/classes/Vector2.xml3
12 files changed, 39 insertions, 10 deletions
diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml
index b79b24e0bc..61df5e092e 100644
--- a/doc/classes/Array.xml
+++ b/doc/classes/Array.xml
@@ -119,7 +119,7 @@
<return type="Variant">
</return>
<description>
- Returns the last element of the array, or [code]null[/code] if the array is empty.
+ Returns the last element of the array. Throws an error and returns [code]null[/code] if the array is empty.
</description>
</method>
<method name="bsearch">
@@ -216,7 +216,7 @@
<return type="Variant">
</return>
<description>
- Returns the first element of the array, or [code]null[/code] if the array is empty.
+ Returns the first element of the array. Throws an error and returns [code]null[/code] if the array is empty.
</description>
</method>
<method name="has">
diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml
index f0ac7d1160..27ead07e6f 100644
--- a/doc/classes/BitMap.xml
+++ b/doc/classes/BitMap.xml
@@ -60,6 +60,7 @@
<argument index="1" name="rect" type="Rect2">
</argument>
<description>
+ Applies morphological dilation to the bitmap. The first argument is the dilation amount, Rect2 is the area where the dilation will be applied.
</description>
</method>
<method name="opaque_to_polygons" qualifiers="const">
diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml
index 12701d8688..297cccaaac 100644
--- a/doc/classes/Engine.xml
+++ b/doc/classes/Engine.xml
@@ -34,7 +34,7 @@
</return>
<description>
Returns a Dictionary of Arrays of donor names.
- {[code]platinum_sponsors[/code], [code]gold_sponsors[/code], [code]mini_sponsors[/code], [code]gold_donors[/code], [code]silver_donors[/code], [code]bronze_donors[/code]}
+ {[code]platinum_sponsors[/code], [code]gold_sponsors[/code], [code]silver_sponsors[/code], [code]bronze_sponsors[/code], [code]mini_sponsors[/code], [code]gold_donors[/code], [code]silver_donors[/code], [code]bronze_donors[/code]}
</description>
</method>
<method name="get_frames_drawn">
diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml
index 05aebef9de..abb105a41c 100644
--- a/doc/classes/Gradient.xml
+++ b/doc/classes/Gradient.xml
@@ -20,7 +20,7 @@
Adds the specified color to the end of the ramp, with the specified offset.
</description>
</method>
- <method name="get_color" qualifiers="const">
+ <method name="get_color">
<return type="Color">
</return>
<argument index="0" name="point" type="int">
@@ -29,7 +29,7 @@
Returns the color of the ramp color at index [code]point[/code].
</description>
</method>
- <method name="get_offset" qualifiers="const">
+ <method name="get_offset">
<return type="float">
</return>
<argument index="0" name="point" type="int">
diff --git a/doc/classes/HSlider.xml b/doc/classes/HSlider.xml
index afe9d10d2e..0cbb4fd455 100644
--- a/doc/classes/HSlider.xml
+++ b/doc/classes/HSlider.xml
@@ -5,6 +5,7 @@
</brief_description>
<description>
Horizontal slider. See [Slider]. This one goes from left (min) to right (max).
+ [b]Note:[/b] The [signal Range.changed] and [signal Range.value_changed] signals are part of the [Range] class which this class inherits from.
</description>
<tutorials>
</tutorials>
diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml
index 2e837dea1d..a9fb50c262 100644
--- a/doc/classes/JSON.xml
+++ b/doc/classes/JSON.xml
@@ -30,6 +30,28 @@
<description>
Converts a [Variant] var to JSON text and returns the result. Useful for serializing data to store or send over the network.
[b]Note:[/b] The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, converting a Variant to JSON text will convert all numerical values to [float] types.
+ Use [code]indent[/code] parameter to pretty print the output.
+ [b]Example output:[/b]
+ [codeblock]
+ ## JSON.print(my_dictionary)
+ {"name":"my_dictionary","version":"1.0.0","entities":[{"name":"entity_0","value":"value_0"},{"name":"entity_1","value":"value_1"}]}
+
+ ## JSON.print(my_dictionary, "\t")
+ {
+ "name": "my_dictionary",
+ "version": "1.0.0",
+ "entities": [
+ {
+ "name": "entity_0",
+ "value": "value_0"
+ },
+ {
+ "name": "entity_1",
+ "value": "value_1"
+ }
+ ]
+ }
+ [/codeblock]
</description>
</method>
</methods>
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
index e921cbd58a..8f66c9df38 100644
--- a/doc/classes/Node.xml
+++ b/doc/classes/Node.xml
@@ -918,6 +918,9 @@
<constant name="NOTIFICATION_INTERNAL_PHYSICS_PROCESS" value="26">
Notification received every frame when the internal physics process flag is set (see [method set_physics_process_internal]).
</constant>
+ <constant name="NOTIFICATION_POST_ENTER_TREE" value="27">
+ Notification received when the node is ready, just before [constant NOTIFICATION_READY] is received. Unlike the latter, it's sent every time the node enters tree, instead of only once.
+ </constant>
<constant name="NOTIFICATION_WM_MOUSE_ENTER" value="1002">
Notification received from the OS when the mouse enters the game window.
Implemented on desktop and web platforms.
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index f13dbbae76..793249afc5 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -990,10 +990,6 @@
</member>
<member name="rendering/limits/time/time_rollover_secs" type="float" setter="" getter="" default="3600">
</member>
- <member name="rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround" type="bool" setter="" getter="" default="false">
- Some NVIDIA GPU drivers have a bug which produces flickering issues for the [code]draw_rect[/code] method, especially as used in [TileMap]. Refer to [url=https://github.com/godotengine/godot/issues/9913]GitHub issue 9913[/url] for details.
- If [code]true[/code], this option enables a "safe" code path for such NVIDIA GPUs at the cost of performance. This option only impacts the GLES2 rendering backend, and only desktop platforms. It is not necessary when using the Vulkan backend.
- </member>
<member name="rendering/quality/2d/use_pixel_snap" type="bool" setter="" getter="" default="false">
If [code]true[/code], forces snapping of polygons to pixels in 2D rendering. May help in some pixel art styles.
</member>
diff --git a/doc/classes/Slider.xml b/doc/classes/Slider.xml
index 68776df603..f18b2ce39f 100644
--- a/doc/classes/Slider.xml
+++ b/doc/classes/Slider.xml
@@ -5,6 +5,7 @@
</brief_description>
<description>
Base class for GUI sliders.
+ [b]Note:[/b] The [signal Range.changed] and [signal Range.value_changed] signals are part of the [Range] class which this class inherits from.
</description>
<tutorials>
</tutorials>
diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml
index b7240655af..d4abac15c0 100644
--- a/doc/classes/TextEdit.xml
+++ b/doc/classes/TextEdit.xml
@@ -430,6 +430,9 @@
<member name="v_scroll_speed" type="float" setter="set_v_scroll_speed" getter="get_v_scroll_speed" default="80.0">
Vertical scroll sensitivity.
</member>
+ <member name="virtual_keyboard_enabled" type="bool" setter="set_virtual_keyboard_enabled" getter="is_virtual_keyboard_enabled" default="true">
+ If [code]true[/code], the native virtual keyboard is shown when focused on platforms that support it.
+ </member>
<member name="wrap_enabled" type="bool" setter="set_wrap_enabled" getter="is_wrap_enabled" default="false">
If [code]true[/code], enables text wrapping when it goes beyond the edge of what is visible.
</member>
diff --git a/doc/classes/VSlider.xml b/doc/classes/VSlider.xml
index 9394d6b430..5830c9eaf3 100644
--- a/doc/classes/VSlider.xml
+++ b/doc/classes/VSlider.xml
@@ -5,6 +5,7 @@
</brief_description>
<description>
Vertical slider. See [Slider]. This one goes from bottom (min) to top (max).
+ [b]Note:[/b] The [signal Range.changed] and [signal Range.value_changed] signals are part of the [Range] class which this class inherits from.
</description>
<tutorials>
</tutorials>
diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml
index c0d8628d88..11716f511b 100644
--- a/doc/classes/Vector2.xml
+++ b/doc/classes/Vector2.xml
@@ -43,7 +43,8 @@
<return type="float">
</return>
<description>
- Returns this vector's angle with respect to the X axis, or [code](1, 0)[/code] vector, in radians.
+ Returns this vector's angle with respect to the positive X axis, or [code](1, 0)[/code] vector, in radians.
+ For example, [code]Vector2.RIGHT.angle()[/code] will return zero, [code]Vector2.DOWN.angle()[/code] will return [code]PI / 2[/code] (a quarter turn, or 90 degrees), and [code]Vector2(1, -1).angle()[/code] will return [code]-PI / 4[/code] (a negative eighth turn, or -45 degrees).
Equivalent to the result of [method @GDScript.atan2] when called with the vector's [member y] and [member x] as parameters: [code]atan2(y, x)[/code].
</description>
</method>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-07 22:42:57 +0000