diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 897a079c5eb..a4819689e4e 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -1,12 +1,14 @@ + SceneTree manages a hierarchy of nodes. + 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. 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 @@ -19,6 +21,7 @@ + Calls [code]method[/code] on each member of the given group. @@ -31,6 +34,7 @@ + Calls [code]method[/code] on each member of the given group, respecting the given [enum GROUP_CALL] flags. @@ -39,6 +43,7 @@ + Changes to the scene at the given [code]path[/code]. @@ -47,6 +52,7 @@ + Changes to the given [PackedScene]. @@ -57,6 +63,7 @@ + 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. @@ -69,18 +76,21 @@ + Returns the peer IDs of all connected peers of this SceneTree's [member network_peer]. + Returns the unique peer ID of this SceneTree's [member network_peer]. + Returns the number of nodes in this SceneTree. @@ -89,12 +99,14 @@ + Returns all nodes assigned to the given group. + Returns the sender's peer ID for the most recently received RPC call. @@ -103,26 +115,28 @@ + Returns [code]true[/code] if the given group exists. - 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. + Returns [code]true[/code] if the most recent InputEvent was marked as handled with [method set_input_as_handled]. - 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). @@ -133,6 +147,7 @@ + Sends the given notification to all members of the [code]group[/code]. @@ -145,6 +160,7 @@ + Sends the given notification to all members of the [code]group[/code], respecting the given [enum GROUP_CALL] flags. @@ -153,18 +169,21 @@ + Queues the given object for deletion, delaying the call to [method Object.free] to after the current frame. + Quits the application. + Reloads the currently active scene. @@ -173,6 +192,7 @@ + If [code]true[/code] the application automatically accepts quitting. @@ -185,6 +205,7 @@ + Sets the given [code]property[/code] to [code]value[/code] on all members of the given group. @@ -199,12 +220,14 @@ + Sets the given [code]property[/code] to [code]value[/code] on all members of the given group, respecting the given [enum GROUP_CALL] flags. + Marks the most recent input event as handled. @@ -213,6 +236,7 @@ + If [code]true[/code] the application quits automatically on going back (e.g. on Android). @@ -227,37 +251,46 @@ + Configures screen stretching to the given [enum StretchMode], [enum StretchAspect], minimum size and [code]shrink[/code]. + The current scene. + The root of the edited scene. 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. + If [code]true[/code] the SceneTree is paused. + If [code]true[/code] the SceneTree's [member network_peer] refuses new incoming connections. + The SceneTree's [Viewport]. + If [code]true[/code] font oversampling is used. + Emitted whenever this SceneTree's [member network_peer] successfully connected to a server. Only emitted on clients. + Emitted whenever this SceneTree's [member network_peer] fails to establish a connection to a server. Only emitted on clients. @@ -266,56 +299,67 @@ + Emitted whenever files are drag-and-dropped onto the window. + Emitted immediately before [method Node._process] is called on every node in the SceneTree. + 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). + Emitted whenever this SceneTree's [member network_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server. + Emitted whenever a node is added to the SceneTree. + Emitted when a node's configuration changed. Only emitted in tool mode. + Emitted whenever a node is removed from the SceneTree. + Emitted immediately before [method Node._physics_process] is called on every node in the SceneTree. + Emitted whenever the screen resolution (fullscreen) or window size (windowed) changes. + Emitted whenever this SceneTree's [member network_peer] disconnected from server. Only emitted on clients. + Emitted whenever the SceneTree hierarchy changed (children being moved or renamed, etc.).