Merge pull request #18069 from mhilbrunner/docs-scenetree

[DOCS] SceneTree

doc/classes/SceneTree.xml

@@ -1,12 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="SceneTree" inherits="MainLoop" category="Core" version="3.1">
 	<brief_description>
+		SceneTree manages a hierarchy of nodes.
 	</brief_description>
 	<description>
+		As one of the most important classes, the [code]SceneTree[/code] manages the hierarchy of nodes in a scene as well as scenes themselves. Nodes can be added, retrieved and removed. The whole scene tree (and thus the current scene) can be paused. Scenes can be loaded, switched and reloaded. You can also use the SceneTree to organize your nodes into groups: every node can be assigned as many groups as you want to create, e.g. a "enemy" group. You can then iterate these groups or even call methods and set properties on all the group's members at once.
 	</description>
 	<tutorials>
 		http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scene_tree.html
-	http://docs.godotengine.org/en/3.0/tutorials/viewports/multiple_resolutions.html
+		http://docs.godotengine.org/en/3.0/tutorials/viewports/multiple_resolutions.html
 	</tutorials>
 	<demos>
 	</demos>
@@ -19,6 +21,7 @@
 			<argument index="1" name="method" type="String">
 			</argument>
 			<description>
+				Calls [code]method[/code] on each member of the given group.
 			</description>
 		</method>
 		<method name="call_group_flags" qualifiers="vararg">
@@ -31,6 +34,7 @@
 			<argument index="2" name="method" type="String">
 			</argument>
 			<description>
+				Calls [code]method[/code] on each member of the given group, respecting the given [enum GROUP_CALL] flags.
 			</description>
 		</method>
 		<method name="change_scene">
@@ -39,6 +43,7 @@
 			<argument index="0" name="path" type="String">
 			</argument>
 			<description>
+				Changes to the scene at the given [code]path[/code].
 			</description>
 		</method>
 		<method name="change_scene_to">
@@ -47,6 +52,7 @@
 			<argument index="0" name="packed_scene" type="PackedScene">
 			</argument>
 			<description>
+				Changes to the given [PackedScene].
 			</description>
 		</method>
 		<method name="create_timer">
@@ -57,6 +63,7 @@
 			<argument index="1" name="pause_mode_process" type="bool" default="true">
 			</argument>
 			<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 false, pausing the SceneTree will also pause the timer.
 			</description>
 		</method>
 		<method name="get_frame" qualifiers="const">
@@ -69,18 +76,21 @@
 			<return type="PoolIntArray">
 			</return>
 			<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>
 			<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>
 			<description>
+				Returns the number of nodes in this SceneTree.
 			</description>
 		</method>
 		<method name="get_nodes_in_group">
@@ -89,12 +99,14 @@
 			<argument index="0" name="group" type="String">
 			</argument>
 			<description>
+				Returns all nodes assigned to the given group.
 			</description>
 		</method>
 		<method name="get_rpc_sender_id" qualifiers="const">
 			<return type="int">
 			</return>
 			<description>
+				Returns the sender's peer ID for the most recently received RPC call.
 			</description>
 		</method>
 		<method name="has_group" qualifiers="const">
@@ -103,26 +115,28 @@
 			<argument index="0" name="name" type="String">
 			</argument>
 			<description>
+				Returns [code]true[/code] if the given group exists.
 			</description>
 		</method>
 		<method name="has_network_peer" qualifiers="const">
 			<return type="bool">
 			</return>
 			<description>
-				Returns true if there is a [NetworkedMultiplayerPeer] set (with [method SceneTree.set_network_peer]).
+				Returns [code]true[/code] if there is a [member network_peer] set.
 			</description>
 		</method>
 		<method name="is_input_handled">
 			<return type="bool">
 			</return>
 			<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>
 			<description>
-				Returns true if this SceneTree's [NetworkedMultiplayerPeer] is in server mode (listening for connections).
+				Returns [code]true[/code] if this SceneTree's [member network_peer] is in server mode (listening for connections).
 			</description>
 		</method>
 		<method name="notify_group">
@@ -133,6 +147,7 @@
 			<argument index="1" name="notification" type="int">
 			</argument>
 			<description>
+				Sends the given notification to all members of the [code]group[/code].
 			</description>
 		</method>
 		<method name="notify_group_flags">
@@ -145,6 +160,7 @@
 			<argument index="2" name="notification" type="int">
 			</argument>
 			<description>
+				Sends the given notification to all members of the [code]group[/code], respecting the given [enum GROUP_CALL] flags.
 			</description>
 		</method>
 		<method name="queue_delete">
@@ -153,18 +169,21 @@
 			<argument index="0" name="obj" type="Object">
 			</argument>
 			<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>
 			<description>
+				Quits the application.
 			</description>
 		</method>
 		<method name="reload_current_scene">
 			<return type="int" enum="Error">
 			</return>
 			<description>
+				Reloads the currently active scene.
 			</description>
 		</method>
 		<method name="set_auto_accept_quit">
@@ -173,6 +192,7 @@
 			<argument index="0" name="enabled" type="bool">
 			</argument>
 			<description>
+				If [code]true[/code] the application automatically accepts quitting.
 			</description>
 		</method>
 		<method name="set_group">
@@ -185,6 +205,7 @@
 			<argument index="2" name="value" type="Variant">
 			</argument>
 			<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">
@@ -199,12 +220,14 @@
 			<argument index="3" name="value" type="Variant">
 			</argument>
 			<description>
+				Sets the given [code]property[/code] to [code]value[/code] on all members of the given group, respecting the given [enum GROUP_CALL] flags.
 			</description>
 		</method>
 		<method name="set_input_as_handled">
 			<return type="void">
 			</return>
 			<description>
+				Marks the most recent input event as handled.
 			</description>
 		</method>
 		<method name="set_quit_on_go_back">
@@ -213,6 +236,7 @@
 			<argument index="0" name="enabled" type="bool">
 			</argument>
 			<description>
+				If [code]true[/code] the application quits automatically on going back (e.g. on Android).
 			</description>
 		</method>
 		<method name="set_screen_stretch">
@@ -227,37 +251,46 @@
 			<argument index="3" name="shrink" type="float" default="1">
 			</argument>
 			<description>
+				Configures screen stretching to the given [enum StretchMode], [enum StretchAspect], minimum size and [code]shrink[/code].
 			</description>
 		</method>
 	</methods>
 	<members>
 		<member name="current_scene" type="Node" setter="set_current_scene" getter="get_current_scene">
+			The current scene.
 		</member>
 		<member name="debug_collisions_hint" type="bool" setter="set_debug_collisions_hint" getter="is_debugging_collisions_hint">
 		</member>
 		<member name="debug_navigation_hint" type="bool" setter="set_debug_navigation_hint" getter="is_debugging_navigation_hint">
 		</member>
 		<member name="edited_scene_root" type="Node" setter="set_edited_scene_root" getter="get_edited_scene_root">
+			The root of the edited scene.
 		</member>
 		<member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer">
 			The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with [method is_network_server()]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals.
 		</member>
 		<member name="paused" type="bool" setter="set_pause" getter="is_paused">
+			If [code]true[/code] the SceneTree is paused.
 		</member>
 		<member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections">
+			If [code]true[/code] the SceneTree's [member network_peer] refuses new incoming connections.
 		</member>
 		<member name="root" type="Viewport" setter="" getter="get_root">
+			The SceneTree's [Viewport].
 		</member>
 		<member name="use_font_oversampling" type="bool" setter="set_use_font_oversampling" getter="is_using_font_oversampling">
+			If [code]true[/code] font oversampling is used.
 		</member>
 	</members>
 	<signals>
 		<signal name="connected_to_server">
 			<description>
+				Emitted whenever this SceneTree's [member network_peer] successfully connected to a server. Only emitted on clients.
 			</description>
 		</signal>
 		<signal name="connection_failed">
 			<description>
+				Emitted whenever this SceneTree's [member network_peer] fails to establish a connection to a server. Only emitted on clients.
 			</description>
 		</signal>
 		<signal name="files_dropped">
@@ -266,56 +299,67 @@
 			<argument index="1" name="screen" type="int">
 			</argument>
 			<description>
+				Emitted whenever files are drag-and-dropped onto the window.
 			</description>
 		</signal>
 		<signal name="idle_frame">
 			<description>
+				Emitted immediately before [method Node._process] is called on every node in the SceneTree.
 			</description>
 		</signal>
 		<signal name="network_peer_connected">
 			<argument index="0" name="id" type="int">
 			</argument>
 			<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>
 			<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="Object">
 			</argument>
 			<description>
+				Emitted whenever a node is added to the SceneTree.
 			</description>
 		</signal>
 		<signal name="node_configuration_warning_changed">
 			<argument index="0" name="node" type="Object">
 			</argument>
 			<description>
+				Emitted when a node's configuration changed. Only emitted in tool mode.
 			</description>
 		</signal>
 		<signal name="node_removed">
 			<argument index="0" name="node" type="Object">
 			</argument>
 			<description>
+				Emitted whenever a node is removed from the SceneTree.
 			</description>
 		</signal>
 		<signal name="physics_frame">
 			<description>
+				Emitted immediately before [method Node._physics_process] is called on every node in the SceneTree.
 			</description>
 		</signal>
 		<signal name="screen_resized">
 			<description>
+				Emitted whenever the screen resolution (fullscreen) or window size (windowed) changes.
 			</description>
 		</signal>
 		<signal name="server_disconnected">
 			<description>
+				Emitted whenever this SceneTree's [member network_peer] disconnected from server. Only emitted on clients.
 			</description>
 		</signal>
 		<signal name="tree_changed">
 			<description>
+				Emitted whenever the SceneTree hierarchy changed (children being moved or renamed, etc.). 
 			</description>
 		</signal>
 	</signals>