summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Directory.xml4
-rw-r--r--doc/classes/EditorInterface.xml44
-rw-r--r--doc/classes/EditorTranslationParserPlugin.xml25
-rw-r--r--doc/classes/HTTPRequest.xml10
-rw-r--r--doc/classes/PackedByteArray.xml16
-rw-r--r--doc/classes/PackedColorArray.xml16
-rw-r--r--doc/classes/PackedFloat32Array.xml16
-rw-r--r--doc/classes/PackedFloat64Array.xml16
-rw-r--r--doc/classes/PackedInt32Array.xml16
-rw-r--r--doc/classes/PackedInt64Array.xml16
-rw-r--r--doc/classes/PackedScene.xml7
-rw-r--r--doc/classes/PackedStringArray.xml16
-rw-r--r--doc/classes/PackedVector2Array.xml16
-rw-r--r--doc/classes/PackedVector3Array.xml16
-rw-r--r--doc/classes/Resource.xml3
-rw-r--r--doc/classes/Timer.xml1
16 files changed, 231 insertions, 7 deletions
diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml
index ed4257a809..a86dbfedde 100644
--- a/doc/classes/Directory.xml
+++ b/doc/classes/Directory.xml
@@ -5,7 +5,7 @@
</brief_description>
<description>
Directory type. It is used to manage directories and their content (not restricted to the project folder).
- When creating a new [Directory], its default opened directory will be [code]res://[/code]. This may change in the future, so it is advised to always use [method open] to initialize your [Directory] where you want to operate, with explicit error checking.
+ When creating a new [Directory], it must be explicitly opened using [method open] before most methods can be used. However, [method file_exists] and [method dir_exists] can be used without opening a directory. If so, they use a path relative to [code]res://[/code].
Here is an example on how to iterate through the files of a directory:
[codeblock]
func dir_contents(path):
@@ -63,6 +63,7 @@
</argument>
<description>
Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path.
+ If the [Directory] is not open, the path is relative to [code]res://[/code].
</description>
</method>
<method name="file_exists">
@@ -72,6 +73,7 @@
</argument>
<description>
Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path.
+ If the [Directory] is not open, the path is relative to [code]res://[/code].
</description>
</method>
<method name="get_current_dir">
diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml
index c2c73a8b83..1d877e632e 100644
--- a/doc/classes/EditorInterface.xml
+++ b/doc/classes/EditorInterface.xml
@@ -72,6 +72,13 @@
Returns an [Array] with the file paths of the currently opened scenes.
</description>
</method>
+ <method name="get_playing_scene" qualifiers="const">
+ <return type="String">
+ </return>
+ <description>
+ Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string.
+ </description>
+ </method>
<method name="get_resource_filesystem">
<return type="EditorFileSystem">
</return>
@@ -117,6 +124,13 @@
Shows the given property on the given [code]object[/code] in the Editor's Inspector dock.
</description>
</method>
+ <method name="is_playing_scene" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ Returns [code]true[/code], if a scene is currently being played; [code]false[/code] otherwise. Paused scenes are considered as being played.
+ </description>
+ </method>
<method name="is_plugin_enabled" qualifiers="const">
<return type="bool">
</return>
@@ -146,6 +160,29 @@
Opens the scene at the given path.
</description>
</method>
+ <method name="play_current_scene">
+ <return type="void">
+ </return>
+ <description>
+ Plays the currently active scene.
+ </description>
+ </method>
+ <method name="play_custom_scene">
+ <return type="void">
+ </return>
+ <argument index="0" name="scene_filepath" type="String">
+ </argument>
+ <description>
+ Plays the scene specified by its filepath.
+ </description>
+ </method>
+ <method name="play_main_scene">
+ <return type="void">
+ </return>
+ <description>
+ Plays the main scene.
+ </description>
+ </method>
<method name="reload_scene_from_path">
<return type="void">
</return>
@@ -201,6 +238,13 @@
Sets the enabled status of a plugin. The plugin name is the same as its directory name.
</description>
</method>
+ <method name="stop_playing_scene">
+ <return type="void">
+ </return>
+ <description>
+ Stops the scene that is currently playing.
+ </description>
+ </method>
</methods>
<members>
<member name="distraction_free_mode" type="bool" setter="set_distraction_free_mode" getter="is_distraction_free_mode_enabled">
diff --git a/doc/classes/EditorTranslationParserPlugin.xml b/doc/classes/EditorTranslationParserPlugin.xml
index 73098efd99..a40ef45916 100644
--- a/doc/classes/EditorTranslationParserPlugin.xml
+++ b/doc/classes/EditorTranslationParserPlugin.xml
@@ -4,22 +4,39 @@
Plugin for adding custom parsers to extract strings that are to be translated from custom files (.csv, .json etc.).
</brief_description>
<description>
- Plugins are registered via [method EditorPlugin.add_translation_parser_plugin] method. To define the parsing and string extraction logic, override the [method parse_text] method in script.
+ Plugins are registered via [method EditorPlugin.add_translation_parser_plugin] method. To define the parsing and string extraction logic, override the [method parse_file] method in script.
The extracted strings will be written into a POT file selected by user under "POT Generation" in "Localization" tab in "Project Settings" menu.
Below shows an example of a custom parser that extracts strings in a CSV file to write into a POT.
[codeblock]
tool
extends EditorTranslationParserPlugin
- func parse_text(text, extracted_strings):
+
+ func parse_file(path, extracted_strings):
+ var file = File.new()
+ file.open(path, File.READ)
+ var text = file.get_as_text()
var split_strs = text.split(",", false, 0)
for s in split_strs:
extracted_strings.append(s)
#print("Extracted string: " + s)
+
func get_recognized_extensions():
return ["csv"]
[/codeblock]
+ [b]Note:[/b] If you override parsing logic for standard script types (GDScript, C#, etc.), it would be better to load the [code]path[/code] argument using [method ResourceLoader.load]. This is because built-in scripts are loaded as [Resource] type, not [File] type.
+ For example:
+ [codeblock]
+ func parse_file(path, extracted_strings):
+ var res = ResourceLoader.load(path, "Script")
+ var text = res.get_source_code()
+ # Parsing logic.
+
+
+ func get_recognized_extensions():
+ return ["gd"]
+ [/codeblock]
</description>
<tutorials>
</tutorials>
@@ -31,10 +48,10 @@
Gets the list of file extensions to associate with this parser, e.g. [code]["csv"][/code].
</description>
</method>
- <method name="parse_text" qualifiers="virtual">
+ <method name="parse_file" qualifiers="virtual">
<return type="void">
</return>
- <argument index="0" name="text" type="String">
+ <argument index="0" name="path" type="String">
</argument>
<argument index="1" name="extracted_strings" type="Array">
</argument>
diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml
index 53ca1fc6a9..0b0d71fccf 100644
--- a/doc/classes/HTTPRequest.xml
+++ b/doc/classes/HTTPRequest.xml
@@ -14,11 +14,19 @@
add_child(http_request)
http_request.connect("request_completed", self, "_http_request_completed")
- # Perform the HTTP request. The URL below returns some JSON as of writing.
+ # Perform a GET request. The URL below returns JSON as of writing.
var error = http_request.request("https://httpbin.org/get")
if error != OK:
push_error("An error occurred in the HTTP request.")
+ # Perform a POST request. The URL below returns JSON as of writing.
+ # Note: Don't make simultaneous requests using a single HTTPRequest node.
+ # The snippet below is provided for reference only.
+ var body = {"name": "Godette"}
+ var error = http_request.request("https://httpbin.org/post", [], true, HTTPClient.METHOD_POST, body)
+ if error != OK:
+ push_error("An error occurred in the HTTP request.")
+
# Called when the HTTP request is completed.
func _http_request_completed(result, response_code, headers, body):
diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml
index b08357e278..08f8558881 100644
--- a/doc/classes/PackedByteArray.xml
+++ b/doc/classes/PackedByteArray.xml
@@ -78,6 +78,15 @@
Returns a copy of the array's contents as [String]. Slower than [method get_string_from_ascii] but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred.
</description>
</method>
+ <method name="has">
+ <return type="bool">
+ </return>
+ <argument index="0" name="value" type="int">
+ </argument>
+ <description>
+ Returns [code]true[/code] if the array contains [code]value[/code].
+ </description>
+ </method>
<method name="hex_encode">
<return type="String">
</return>
@@ -152,6 +161,13 @@
Returns the size of the array.
</description>
</method>
+ <method name="sort">
+ <return type="void">
+ </return>
+ <description>
+ Sorts the elements of the array in ascending order.
+ </description>
+ </method>
<method name="subarray">
<return type="PackedByteArray">
</return>
diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml
index 06228e4dac..ec087e1b39 100644
--- a/doc/classes/PackedColorArray.xml
+++ b/doc/classes/PackedColorArray.xml
@@ -44,6 +44,15 @@
Returns [code]true[/code] if the array is empty.
</description>
</method>
+ <method name="has">
+ <return type="bool">
+ </return>
+ <argument index="0" name="value" type="Color">
+ </argument>
+ <description>
+ Returns [code]true[/code] if the array contains [code]value[/code].
+ </description>
+ </method>
<method name="insert">
<return type="int">
</return>
@@ -107,6 +116,13 @@
Returns the size of the array.
</description>
</method>
+ <method name="sort">
+ <return type="void">
+ </return>
+ <description>
+ Sorts the elements of the array in ascending order.
+ </description>
+ </method>
</methods>
<constants>
</constants>
diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml
index ee82586cdb..a6b726944b 100644
--- a/doc/classes/PackedFloat32Array.xml
+++ b/doc/classes/PackedFloat32Array.xml
@@ -45,6 +45,15 @@
Returns [code]true[/code] if the array is empty.
</description>
</method>
+ <method name="has">
+ <return type="bool">
+ </return>
+ <argument index="0" name="value" type="float">
+ </argument>
+ <description>
+ Returns [code]true[/code] if the array contains [code]value[/code].
+ </description>
+ </method>
<method name="insert">
<return type="int">
</return>
@@ -108,6 +117,13 @@
Returns the size of the array.
</description>
</method>
+ <method name="sort">
+ <return type="void">
+ </return>
+ <description>
+ Sorts the elements of the array in ascending order.
+ </description>
+ </method>
</methods>
<constants>
</constants>
diff --git a/doc/classes/PackedFloat64Array.xml b/doc/classes/PackedFloat64Array.xml
index ce2300c65a..f867cda3b6 100644
--- a/doc/classes/PackedFloat64Array.xml
+++ b/doc/classes/PackedFloat64Array.xml
@@ -45,6 +45,15 @@
Returns [code]true[/code] if the array is empty.
</description>
</method>
+ <method name="has">
+ <return type="bool">
+ </return>
+ <argument index="0" name="value" type="float">
+ </argument>
+ <description>
+ Returns [code]true[/code] if the array contains [code]value[/code].
+ </description>
+ </method>
<method name="insert">
<return type="int">
</return>
@@ -108,6 +117,13 @@
Returns the size of the array.
</description>
</method>
+ <method name="sort">
+ <return type="void">
+ </return>
+ <description>
+ Sorts the elements of the array in ascending order.
+ </description>
+ </method>
</methods>
<constants>
</constants>
diff --git a/doc/classes/PackedInt32Array.xml b/doc/classes/PackedInt32Array.xml
index 176c624956..b796d9cacb 100644
--- a/doc/classes/PackedInt32Array.xml
+++ b/doc/classes/PackedInt32Array.xml
@@ -45,6 +45,15 @@
Returns [code]true[/code] if the array is empty.
</description>
</method>
+ <method name="has">
+ <return type="bool">
+ </return>
+ <argument index="0" name="value" type="int">
+ </argument>
+ <description>
+ Returns [code]true[/code] if the array contains [code]value[/code].
+ </description>
+ </method>
<method name="insert">
<return type="int">
</return>
@@ -108,6 +117,13 @@
Returns the array size.
</description>
</method>
+ <method name="sort">
+ <return type="void">
+ </return>
+ <description>
+ Sorts the elements of the array in ascending order.
+ </description>
+ </method>
</methods>
<constants>
</constants>
diff --git a/doc/classes/PackedInt64Array.xml b/doc/classes/PackedInt64Array.xml
index d8a8071590..3d0d9a1360 100644
--- a/doc/classes/PackedInt64Array.xml
+++ b/doc/classes/PackedInt64Array.xml
@@ -45,6 +45,15 @@
Returns [code]true[/code] if the array is empty.
</description>
</method>
+ <method name="has">
+ <return type="bool">
+ </return>
+ <argument index="0" name="value" type="int">
+ </argument>
+ <description>
+ Returns [code]true[/code] if the array contains [code]value[/code].
+ </description>
+ </method>
<method name="insert">
<return type="int">
</return>
@@ -108,6 +117,13 @@
Returns the array size.
</description>
</method>
+ <method name="sort">
+ <return type="void">
+ </return>
+ <description>
+ Sorts the elements of the array in ascending order.
+ </description>
+ </method>
</methods>
<constants>
</constants>
diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml
index 2d70dea012..bb56330248 100644
--- a/doc/classes/PackedScene.xml
+++ b/doc/classes/PackedScene.xml
@@ -7,6 +7,13 @@
A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself.
Can be used to save a node to a file. When saving, the node as well as all the node it owns get saved (see [code]owner[/code] property on [Node]).
[b]Note:[/b] The node doesn't need to own itself.
+ [b]Example of loading a saved scene:[/b]
+ [codeblock]
+ # Use `load()` instead of `preload()` if the path isn't known at compile-time.
+ var scene = preload("res://scene.tscn").instance()
+ # Add the node as a child of the node the script is attached to.
+ add_child(scene)
+ [/codeblock]
[b]Example of saving a node with different owners:[/b] The following example creates 3 objects: [code]Node2D[/code] ([code]node[/code]), [code]RigidBody2D[/code] ([code]rigid[/code]) and [code]CollisionObject2D[/code] ([code]collision[/code]). [code]collision[/code] is a child of [code]rigid[/code] which is a child of [code]node[/code]. Only [code]rigid[/code] is owned by [code]node[/code] and [code]pack[/code] will therefore only save those two nodes, but not [code]collision[/code].
[codeblock]
# Create the objects.
diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml
index 9526f5899d..f36af66d6d 100644
--- a/doc/classes/PackedStringArray.xml
+++ b/doc/classes/PackedStringArray.xml
@@ -44,6 +44,15 @@
Returns [code]true[/code] if the array is empty.
</description>
</method>
+ <method name="has">
+ <return type="bool">
+ </return>
+ <argument index="0" name="value" type="String">
+ </argument>
+ <description>
+ Returns [code]true[/code] if the array contains [code]value[/code].
+ </description>
+ </method>
<method name="insert">
<return type="int">
</return>
@@ -107,6 +116,13 @@
Returns the size of the array.
</description>
</method>
+ <method name="sort">
+ <return type="void">
+ </return>
+ <description>
+ Sorts the elements of the array in ascending order.
+ </description>
+ </method>
</methods>
<constants>
</constants>
diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml
index 87f202357c..ecc535e488 100644
--- a/doc/classes/PackedVector2Array.xml
+++ b/doc/classes/PackedVector2Array.xml
@@ -44,6 +44,15 @@
Returns [code]true[/code] if the array is empty.
</description>
</method>
+ <method name="has">
+ <return type="bool">
+ </return>
+ <argument index="0" name="value" type="Vector2">
+ </argument>
+ <description>
+ Returns [code]true[/code] if the array contains [code]value[/code].
+ </description>
+ </method>
<method name="insert">
<return type="int">
</return>
@@ -107,6 +116,13 @@
Returns the size of the array.
</description>
</method>
+ <method name="sort">
+ <return type="void">
+ </return>
+ <description>
+ Sorts the elements of the array in ascending order.
+ </description>
+ </method>
</methods>
<constants>
</constants>
diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml
index 7bfa684ff5..f268fbcc83 100644
--- a/doc/classes/PackedVector3Array.xml
+++ b/doc/classes/PackedVector3Array.xml
@@ -44,6 +44,15 @@
Returns [code]true[/code] if the array is empty.
</description>
</method>
+ <method name="has">
+ <return type="bool">
+ </return>
+ <argument index="0" name="value" type="Vector3">
+ </argument>
+ <description>
+ Returns [code]true[/code] if the array contains [code]value[/code].
+ </description>
+ </method>
<method name="insert">
<return type="int">
</return>
@@ -107,6 +116,13 @@
Returns the size of the array.
</description>
</method>
+ <method name="sort">
+ <return type="void">
+ </return>
+ <description>
+ Sorts the elements of the array in ascending order.
+ </description>
+ </method>
</methods>
<constants>
</constants>
diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml
index 5bc34772c8..0aa40dffb3 100644
--- a/doc/classes/Resource.xml
+++ b/doc/classes/Resource.xml
@@ -23,7 +23,8 @@
<argument index="0" name="subresources" type="bool" default="false">
</argument>
<description>
- Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency, this can be changed by passing [code]true[/code] to the [code]subresources[/code] argument.
+ Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing [code]true[/code] to the [code]subresources[/code] argument which will copy the subresources.
+ [b]Note:[/b] If [code]subresources[/code] is [code]true[/code], this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared.
</description>
</method>
<method name="get_local_scene" qualifiers="const">
diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml
index c1e5987a06..5d684755fa 100644
--- a/doc/classes/Timer.xml
+++ b/doc/classes/Timer.xml
@@ -5,6 +5,7 @@
</brief_description>
<description>
Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one-shot" mode.
+ [b]Note:[/b] To create an one-shot timer without instantiating a node, use [method SceneTree.create_timer].
</description>
<tutorials>
</tutorials>
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-01 14:41:49 +0000