scala-native-gdextension
API
Generated with
scala-native-gdextension/gdext/gdext.classes/SceneTree

SceneTree

gdext.classes.SceneTree
See theSceneTree companion object
abstract class SceneTree extends MainLoop

Generated wrapper for Godot's SceneTree, extends MainLoop.

Attributes

Companion
object
Graph
Supertypes
class MainLoop
class Object
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

final def changeSceneToFile(path: String): Long

SceneTree.change_scene_to_file

SceneTree.change_scene_to_file

Attributes

final def changeSceneToNode(node: Node): Long

SceneTree.change_scene_to_node

SceneTree.change_scene_to_node

Attributes

final def changeSceneToPacked(packed_scene: PackedScene): Long

SceneTree.change_scene_to_packed

SceneTree.change_scene_to_packed

Attributes

final def createTimer(time_sec: Double, process_always: Boolean, process_in_physics: Boolean, ignore_time_scale: Boolean): SceneTreeTimer

SceneTree.create_timer. Returns an owned reference: release it with unref() or inside Gd.scoped.

SceneTree.create_timer. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

final def createTween(): Tween

SceneTree.create_tween. Returns an owned reference: release it with unref() or inside Gd.scoped.

SceneTree.create_tween. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

final def getCurrentScene(): Node

SceneTree.get_current_scene

SceneTree.get_current_scene

Attributes

final def getEditedSceneRoot(): Node

SceneTree.get_edited_scene_root

SceneTree.get_edited_scene_root

Attributes

final def getFirstNodeInGroup(group: StringName): Node

SceneTree.get_first_node_in_group

SceneTree.get_first_node_in_group

Attributes

final def getFrame(): Long

SceneTree.get_frame

SceneTree.get_frame

Attributes

final def getNodeCount(): Long

SceneTree.get_node_count

SceneTree.get_node_count

Attributes

final def getNodeCountInGroup(group: StringName): Long

SceneTree.get_node_count_in_group

SceneTree.get_node_count_in_group

Attributes

final def getRoot(): Window

SceneTree.get_root

SceneTree.get_root

Attributes

override def godotClassName: String

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

Attributes

Definition Classes
final def hasGroup(name: StringName): Boolean

SceneTree.has_group

SceneTree.has_group

Attributes

final def isAccessibilityEnabled(): Boolean

SceneTree.is_accessibility_enabled

SceneTree.is_accessibility_enabled

Attributes

final def isAccessibilitySupported(): Boolean

SceneTree.is_accessibility_supported

SceneTree.is_accessibility_supported

Attributes

final def isAutoAcceptQuit(): Boolean

SceneTree.is_auto_accept_quit

SceneTree.is_auto_accept_quit

Attributes

final def isDebuggingCollisionsHint(): Boolean

SceneTree.is_debugging_collisions_hint

SceneTree.is_debugging_collisions_hint

Attributes

final def isDebuggingNavigationHint(): Boolean

SceneTree.is_debugging_navigation_hint

SceneTree.is_debugging_navigation_hint

Attributes

final def isDebuggingPathsHint(): Boolean

SceneTree.is_debugging_paths_hint

SceneTree.is_debugging_paths_hint

Attributes

final def isMultiplayerPollEnabled(): Boolean

SceneTree.is_multiplayer_poll_enabled

SceneTree.is_multiplayer_poll_enabled

Attributes

final def isPaused(): Boolean

SceneTree.is_paused

SceneTree.is_paused

Attributes

final def isPhysicsInterpolationEnabled(): Boolean

SceneTree.is_physics_interpolation_enabled

SceneTree.is_physics_interpolation_enabled

Attributes

final def isQuitOnGoBack(): Boolean

SceneTree.is_quit_on_go_back

SceneTree.is_quit_on_go_back

Attributes

final def notifyGroup(group: StringName, notification: Long): Unit

SceneTree.notify_group

SceneTree.notify_group

Attributes

final def notifyGroupFlags(call_flags: Long, group: StringName, notification: Long): Unit

SceneTree.notify_group_flags

SceneTree.notify_group_flags

Attributes

final def queueDelete(obj: Object): Unit

SceneTree.queue_delete

SceneTree.queue_delete

Attributes

final def quit(exit_code: Long): Unit

SceneTree.quit

SceneTree.quit

Attributes

final def reloadCurrentScene(): Long

SceneTree.reload_current_scene

SceneTree.reload_current_scene

Attributes

final def setAutoAcceptQuit(enabled: Boolean): Unit

SceneTree.set_auto_accept_quit

SceneTree.set_auto_accept_quit

Attributes

final def setCurrentScene(child_node: Node): Unit

SceneTree.set_current_scene

SceneTree.set_current_scene

Attributes

final def setDebugCollisionsHint(enable: Boolean): Unit

SceneTree.set_debug_collisions_hint

SceneTree.set_debug_collisions_hint

Attributes

final def setDebugNavigationHint(enable: Boolean): Unit

SceneTree.set_debug_navigation_hint

SceneTree.set_debug_navigation_hint

Attributes

final def setDebugPathsHint(enable: Boolean): Unit

SceneTree.set_debug_paths_hint

SceneTree.set_debug_paths_hint

Attributes

final def setEditedSceneRoot(scene: Node): Unit

SceneTree.set_edited_scene_root

SceneTree.set_edited_scene_root

Attributes

final def setMultiplayerPollEnabled(enabled: Boolean): Unit

SceneTree.set_multiplayer_poll_enabled

SceneTree.set_multiplayer_poll_enabled

Attributes

final def setPause(enable: Boolean): Unit

SceneTree.set_pause

SceneTree.set_pause

Attributes

final def setPhysicsInterpolationEnabled(enabled: Boolean): Unit

SceneTree.set_physics_interpolation_enabled

SceneTree.set_physics_interpolation_enabled

Attributes

final def setQuitOnGoBack(enabled: Boolean): Unit

SceneTree.set_quit_on_go_back

SceneTree.set_quit_on_go_back

Attributes

final def unloadCurrentScene(): Unit

SceneTree.unload_current_scene

SceneTree.unload_current_scene

Attributes

Inherited methods

def _can_handle(obj: GodotObject): Boolean

EditorInspectorPlugin: can this plugin handle obj's inspector?

EditorInspectorPlugin: can this plugin handle obj's inspector?

Attributes

Inherited from:
GodotScriptClass
def _enter_tree(): Unit

EditorPlugin/Node: entered the (editor) tree.

EditorPlugin/Node: entered the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _exit_tree(): Unit

EditorPlugin/Node: leaving the (editor) tree.

EditorPlugin/Node: leaving the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _input(event: InputEvent): Unit

Called for every unhandled-or-not input event (Node._input).

Called for every unhandled-or-not input event (Node._input).

Attributes

Inherited from:
GodotScriptClass
def _parse_property(obj: GodotObject, varType: Long, name: String, hintType: Long, hintString: String, usage: Long, wide: Boolean): Boolean

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

Attributes

Inherited from:
GodotScriptClass
def _physics_process(delta: Double): Unit

Called every physics frame; delta is the fixed physics step.

Called every physics frame; delta is the fixed physics step.

Attributes

Inherited from:
GodotScriptClass
def _process(delta: Double): Unit

Called every rendered frame; delta is seconds since the last frame.

Called every rendered frame; delta is seconds since the last frame.

Attributes

Inherited from:
GodotScriptClass
def _ready(): Unit

Called when the node enters the scene tree and is ready.

Called when the node enters the scene tree and is ready.

Attributes

Inherited from:
GodotScriptClass
def _shortcut_input(event: InputEvent): Unit

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_input(event: InputEvent): Unit

Called for input not consumed by the UI (Node._unhandled_input).

Called for input not consumed by the UI (Node._unhandled_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_key_input(event: InputEvent): Unit

Called for unhandled key input (Node._unhandled_key_input).

Called for unhandled key input (Node._unhandled_key_input).

Attributes

Inherited from:
GodotScriptClass
def _update_property(): Unit

EditorProperty: refresh the widget from the edited property's value.

EditorProperty: refresh the widget from the edited property's value.

Attributes

Inherited from:
GodotScriptClass
final def canTranslateMessages(): Boolean

Object.can_translate_messages

Object.can_translate_messages

Attributes

Inherited from:
Object
final def cancelFree(): Unit

Object.cancel_free

Object.cancel_free

Attributes

Inherited from:
Object
def cast[U <: GodotScriptClass](using meta: ClassMeta[U]): U

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Attributes

Inherited from:
GodotScriptClass
def free(): Unit

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Attributes

Inherited from:
GodotScriptClass
final def getInstanceId(): Long

Object.get_instance_id

Object.get_instance_id

Attributes

Inherited from:
Object
final def getMethodArgumentCount(method: StringName): Long

Object.get_method_argument_count

Object.get_method_argument_count

Attributes

Inherited from:
Object
final def getTranslationDomain(): StringName

Object.get_translation_domain

Object.get_translation_domain

Attributes

Inherited from:
Object
final def hasConnections(signal: StringName): Boolean

Object.has_connections

Object.has_connections

Attributes

Inherited from:
Object
final def hasMeta(name: StringName): Boolean

Object.has_meta

Object.has_meta

Attributes

Inherited from:
Object
final def hasMethod(method: StringName): Boolean

Object.has_method

Object.has_method

Attributes

Inherited from:
Object
final def hasSignal(signal: StringName): Boolean

Object.has_signal

Object.has_signal

Attributes

Inherited from:
Object
final def hasUserSignal(signal: StringName): Boolean

Object.has_user_signal

Object.has_user_signal

Attributes

Inherited from:
Object
final def hostObject: GodotObject

The engine-side object handle for this instance.

The engine-side object handle for this instance.

Attributes

Inherited from:
GodotScriptClass
final def instanceId: InstanceId

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

Attributes

Inherited from:
GodotScriptClass
final def isBlockingSignals(): Boolean

Object.is_blocking_signals

Object.is_blocking_signals

Attributes

Inherited from:
Object
final def isClass(`class`: String): Boolean

Object.is_class

Object.is_class

Attributes

Inherited from:
Object
final def isQueuedForDeletion(): Boolean

Object.is_queued_for_deletion

Object.is_queued_for_deletion

Attributes

Inherited from:
Object
final def isRefCounted: Boolean

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

Attributes

Inherited from:
GodotScriptClass
def keep(): this.type

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Attributes

Inherited from:
GodotScriptClass
final def notification(what: Long, reversed: Boolean): Unit

Object.notification

Object.notification

Attributes

Inherited from:
Object
final def notifyPropertyListChanged(): Unit

Object.notify_property_list_changed

Object.notify_property_list_changed

Attributes

Inherited from:
Object
final def propertyCanRevert(property: StringName): Boolean

Object.property_can_revert

Object.property_can_revert

Attributes

Inherited from:
Object
def refInc(): this.type

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Attributes

Inherited from:
GodotScriptClass
final def removeMeta(name: StringName): Unit

Object.remove_meta

Object.remove_meta

Attributes

Inherited from:
Object
final def removeUserSignal(signal: StringName): Unit

Object.remove_user_signal

Object.remove_user_signal

Attributes

Inherited from:
Object
final def setBlockSignals(enable: Boolean): Unit

Object.set_block_signals

Object.set_block_signals

Attributes

Inherited from:
Object
final def setMessageTranslation(enable: Boolean): Unit

Object.set_message_translation

Object.set_message_translation

Attributes

Inherited from:
Object
final def setTranslationDomain(domain: StringName): Unit

Object.set_translation_domain

Object.set_translation_domain

Attributes

Inherited from:
Object
final def tr(message: StringName, context: StringName): String

Object.tr

Object.tr

Attributes

Inherited from:
Object
final def trN(message: StringName, plural_message: StringName, n: Long, context: StringName): String

Object.tr_n

Object.tr_n

Attributes

Inherited from:
Object
def unref(): Unit

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Attributes

Inherited from:
GodotScriptClass
final def withHost(o: GDExtensionObjectPtr): this.type

Set the handle and return this (fluent, for wrapping fetched objects).

Set the handle and return this (fluent, for wrapping fetched objects).

Attributes

Inherited from:
GodotScriptClass
Generated with