Click or drag to resize

SceneTree Properties

The SceneTree type exposes the following members.

Properties
  NameDescription
Public propertyCurrentScene

The current scene.

Public propertyDebugCollisionsHint

If true, collision shapes will be visible when running the game from the editor for debugging purposes.

Public propertyDebugNavigationHint

If true, navigation polygons will be visible when running the game from the editor for debugging purposes.

Public propertyDynamicObject
Gets a new DynamicGodotObject associated with this instance.
(Inherited from Object.)
Public propertyEditedSceneRoot

The root of the edited scene.

Public propertyMultiplayer

The default MultiplayerAPI instance for this SceneTree.

Public propertyMultiplayerPoll

If true (default value), enables automatic polling of the MultiplayerAPI for this SceneTree during idle_frame.

If false, you need to manually call Poll to process network packets and deliver RPCs/RSETs. This allows running RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual Mutex protection when accessing the MultiplayerAPI from threads.

Public propertyNativeInstance (Inherited from Object.)
Public propertyNetworkPeer

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 IsNetworkServer) and will set the root node's network mode to master, or it will become a regular peer with the root node set to puppet. 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.

Public propertyPaused

If true, the SceneTree is paused. Doing so will have the following behavior:

- 2D and 3D physics will be stopped.

- _Process(Single), _PhysicsProcess(Single) and _Input(InputEvent) will not be called anymore in nodes.

Public propertyRefuseNewNetworkConnections

If true, the SceneTree's NetworkPeer refuses new incoming connections.

Public propertyRoot

The SceneTree's root Viewport.

Public propertyUseFontOversampling

If true, font oversampling is used.

Top
See Also