mirror of
https://github.com/godotengine/godot.git
synced 2026-01-06 10:11:57 +03:00
doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
@@ -14,12 +14,9 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="call_group" qualifiers="vararg">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="group" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="method" type="String">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="group" type="String" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<description>
|
||||
Calls [code]method[/code] on each member of the given group. You can pass arguments to [code]method[/code] by specifying them at the end of the method call.
|
||||
[b]Note:[/b] [code]method[/code] may only have 5 arguments at most (7 arguments passed to this method in total).
|
||||
@@ -27,14 +24,10 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="call_group_flags" qualifiers="vararg">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="flags" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="group" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="method" type="String">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="flags" type="int" />
|
||||
<argument index="1" name="group" type="String" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<description>
|
||||
Calls [code]method[/code] on each member of the given group, respecting the given [enum GroupCallFlags]. You can pass arguments to [code]method[/code] by specifying them at the end of the method call.
|
||||
[b]Note:[/b] [code]method[/code] may only have 5 arguments at most (8 arguments passed to this method in total).
|
||||
@@ -42,10 +35,8 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="change_scene">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="path" type="String">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<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.
|
||||
@@ -53,10 +44,8 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="change_scene_to">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="packed_scene" type="PackedScene">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="packed_scene" type="PackedScene" />
|
||||
<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.
|
||||
@@ -64,12 +53,9 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_timer">
|
||||
<return type="SceneTreeTimer">
|
||||
</return>
|
||||
<argument index="0" name="time_sec" type="float">
|
||||
</argument>
|
||||
<argument index="1" name="pause_mode_process" type="bool" default="true">
|
||||
</argument>
|
||||
<return type="SceneTreeTimer" />
|
||||
<argument index="0" name="time_sec" type="float" />
|
||||
<argument index="1" name="pause_mode_process" type="bool" default="true" />
|
||||
<description>
|
||||
Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this [SceneTree]. If [code]pause_mode_process[/code] is set to [code]false[/code], pausing the [SceneTree] will also pause the timer.
|
||||
Commonly used to create a one-shot delay timer as in the following example:
|
||||
@@ -83,196 +69,153 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_frame" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the current frame number, i.e. the total frame count since the application started.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_network_connected_peers" qualifiers="const">
|
||||
<return type="PoolIntArray">
|
||||
</return>
|
||||
<return type="PoolIntArray" />
|
||||
<description>
|
||||
Returns the peer IDs of all connected peers of this [SceneTree]'s [member network_peer].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_network_unique_id" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the unique peer ID of this [SceneTree]'s [member network_peer].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node_count" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the number of nodes in this [SceneTree].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_nodes_in_group">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<argument index="0" name="group" type="String">
|
||||
</argument>
|
||||
<return type="Array" />
|
||||
<argument index="0" name="group" type="String" />
|
||||
<description>
|
||||
Returns a list of all nodes assigned to the given group.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_rpc_sender_id" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the sender's peer ID for the most recently received RPC call.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_group" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the given group exists.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_network_peer" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a [member network_peer] set.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_input_handled">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the most recent [InputEvent] was marked as handled with [method set_input_as_handled].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_network_server" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this [SceneTree]'s [member network_peer] is in server mode (listening for connections).
|
||||
</description>
|
||||
</method>
|
||||
<method name="notify_group">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="group" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="notification" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="group" type="String" />
|
||||
<argument index="1" name="notification" type="int" />
|
||||
<description>
|
||||
Sends the given notification to all members of the [code]group[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="notify_group_flags">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="call_flags" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="group" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="notification" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="call_flags" type="int" />
|
||||
<argument index="1" name="group" type="String" />
|
||||
<argument index="2" name="notification" type="int" />
|
||||
<description>
|
||||
Sends the given notification to all members of the [code]group[/code], respecting the given [enum GroupCallFlags].
|
||||
</description>
|
||||
</method>
|
||||
<method name="queue_delete">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="obj" type="Object">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="obj" type="Object" />
|
||||
<description>
|
||||
Queues the given object for deletion, delaying the call to [method Object.free] to after the current frame.
|
||||
</description>
|
||||
</method>
|
||||
<method name="quit">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="exit_code" type="int" default="-1">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="exit_code" type="int" default="-1" />
|
||||
<description>
|
||||
Quits the application at the end of the current iteration. A process [code]exit_code[/code] can optionally be passed as an argument. If this argument is [code]0[/code] or greater, it will override the [member OS.exit_code] defined before quitting the application.
|
||||
[b]Note:[/b] On iOS this method doesn't work. Instead, as recommended by the iOS Human Interface Guidelines, the user is expected to close apps via the Home button.
|
||||
</description>
|
||||
</method>
|
||||
<method name="reload_current_scene">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
Reloads the currently active scene.
|
||||
Returns [constant OK] on success, [constant ERR_UNCONFIGURED] if no [member current_scene] was defined yet, [constant ERR_CANT_OPEN] if [member current_scene] cannot be loaded into a [PackedScene], or [constant ERR_CANT_CREATE] if the scene cannot be instantiated.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_auto_accept_quit">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="enabled" type="bool">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="enabled" type="bool" />
|
||||
<description>
|
||||
If [code]true[/code], the application automatically accepts quitting. Enabled by default.
|
||||
For mobile platforms, see [method set_quit_on_go_back].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_group">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="group" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="property" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="value" type="Variant">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="group" type="String" />
|
||||
<argument index="1" name="property" type="String" />
|
||||
<argument index="2" name="value" type="Variant" />
|
||||
<description>
|
||||
Sets the given [code]property[/code] to [code]value[/code] on all members of the given group.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_group_flags">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="call_flags" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="group" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="property" type="String">
|
||||
</argument>
|
||||
<argument index="3" name="value" type="Variant">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="call_flags" type="int" />
|
||||
<argument index="1" name="group" type="String" />
|
||||
<argument index="2" name="property" type="String" />
|
||||
<argument index="3" name="value" type="Variant" />
|
||||
<description>
|
||||
Sets the given [code]property[/code] to [code]value[/code] on all members of the given group, respecting the given [enum GroupCallFlags].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_input_as_handled">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
Marks the most recent [InputEvent] as handled.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_quit_on_go_back">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="enabled" type="bool">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="enabled" type="bool" />
|
||||
<description>
|
||||
If [code]true[/code], the application quits automatically on going back (e.g. on Android). Enabled by default.
|
||||
To handle 'Go Back' button when this option is disabled, use [constant MainLoop.NOTIFICATION_WM_GO_BACK_REQUEST].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_screen_stretch">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="mode" type="int" enum="SceneTree.StretchMode">
|
||||
</argument>
|
||||
<argument index="1" name="aspect" type="int" enum="SceneTree.StretchAspect">
|
||||
</argument>
|
||||
<argument index="2" name="minsize" type="Vector2">
|
||||
</argument>
|
||||
<argument index="3" name="shrink" type="float" default="1">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="mode" type="int" enum="SceneTree.StretchMode" />
|
||||
<argument index="1" name="aspect" type="int" enum="SceneTree.StretchAspect" />
|
||||
<argument index="2" name="minsize" type="Vector2" />
|
||||
<argument index="3" name="shrink" type="float" default="1" />
|
||||
<description>
|
||||
Configures screen stretching to the given [enum StretchMode], [enum StretchAspect], minimum size and [code]shrink[/code] ratio.
|
||||
</description>
|
||||
@@ -328,19 +271,15 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="files_dropped">
|
||||
<argument index="0" name="files" type="PoolStringArray">
|
||||
</argument>
|
||||
<argument index="1" name="screen" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="files" type="PoolStringArray" />
|
||||
<argument index="1" name="screen" type="int" />
|
||||
<description>
|
||||
Emitted when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="global_menu_action">
|
||||
<argument index="0" name="id" type="Variant">
|
||||
</argument>
|
||||
<argument index="1" name="meta" type="Variant">
|
||||
</argument>
|
||||
<argument index="0" name="id" type="Variant" />
|
||||
<argument index="1" name="meta" type="Variant" />
|
||||
<description>
|
||||
Emitted whenever global menu item is clicked.
|
||||
</description>
|
||||
@@ -351,43 +290,37 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="network_peer_connected">
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
Emitted whenever this [SceneTree]'s [member network_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1).
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="network_peer_disconnected">
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
Emitted whenever this [SceneTree]'s [member network_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="node_added">
|
||||
<argument index="0" name="node" type="Node">
|
||||
</argument>
|
||||
<argument index="0" name="node" type="Node" />
|
||||
<description>
|
||||
Emitted whenever a node is added to the [SceneTree].
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="node_configuration_warning_changed">
|
||||
<argument index="0" name="node" type="Node">
|
||||
</argument>
|
||||
<argument index="0" name="node" type="Node" />
|
||||
<description>
|
||||
Emitted when a node's configuration changed. Only emitted in [code]tool[/code] mode.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="node_removed">
|
||||
<argument index="0" name="node" type="Node">
|
||||
</argument>
|
||||
<argument index="0" name="node" type="Node" />
|
||||
<description>
|
||||
Emitted whenever a node is removed from the [SceneTree].
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="node_renamed">
|
||||
<argument index="0" name="node" type="Node">
|
||||
</argument>
|
||||
<argument index="0" name="node" type="Node" />
|
||||
<description>
|
||||
Emitted whenever a node is renamed.
|
||||
</description>
|
||||
|
||||
Reference in New Issue
Block a user