class Godot::SceneTree

Overview

=========================================================================== SceneTree Ergonomic Extensions

Defined in:

libgodot/extensions/scene_tree.cr
libgodot/generated/classes/classes_part5.cr
libgodot/object.cr

Constructors

Instance Method Summary

Instance methods inherited from class Godot::MainLoop

emit_on_request_permissions_result(*args) : Void emit_on_request_permissions_result, on_request_permissions_result : Godot::TypedSignal(String, Bool) on_request_permissions_result

Constructor methods inherited from class Godot::MainLoop

new(pointer : Pointer(Void) = Pointer(Void).null) new

Instance methods inherited from class Godot::Object

==(other : Godot::Object) : Bool
==(other : Nil) : Bool ==, _enter_tree : Void _enter_tree, _exit_tree : Void _exit_tree, _godot_call_tool_button(button_name : String) : Void _godot_call_tool_button, _godot_call_virtual(method_name : String, delta : Float64) : Void _godot_call_virtual, _godot_call_virtual_with_data(method_name : String, args : Pointer(Pointer(Void)), ret : Pointer(Void)) : Void _godot_call_virtual_with_data, _godot_get_property(prop_name : String, ret_ptr : Pointer(Void)) : Void _godot_get_property, _godot_set_property(prop_name : String, val_ptr : Pointer(Void)) : Void _godot_set_property, _physics_process(delta : Float64) : Void _physics_process, _process(delta : Float64) : Void _process, _ready : Void _ready, add_user_signal(signal : String, arguments : Pointer(Void)) : Void add_user_signal, alive? : Bool alive?, await_signal(signal_name : String, timeout_sec : Float64 | Nil = nil) : Array(Variant) await_signal, blocking_signals? : Bool blocking_signals?, call(method : String, *args) : Pointer(Void) call, call_bool(method : String, *args) : Bool call_bool, call_deferred(method : String, *args) : Pointer(Void) call_deferred, call_f64(method : String, *args) : Float64 call_f64, call_i64(method : String, *args) : Int64 call_i64, call_obj(method : String, *args) : Node | Nil call_obj, call_obj_as(type : T.class, method : String, *args) : T | Nil forall T call_obj_as, call_str(method : String, *args) : String call_str, callv(method : String, arg_array : Pointer(Void)) : Pointer(Void) callv, can_translate_messages : Bool can_translate_messages, can_translate_messages? : Bool can_translate_messages?, cancel_free : Void cancel_free, check_alive! : Void check_alive!, class?(godot_class : String) : Bool class?, connect(signal_name : String, flags : Godot::ConnectFlags = ::Godot::ConnectFlags::None, callback : Proc(Array(Variant), Void) | Nil = nil) : SignalSubscription
connect(signal_name : String, flags : Godot::ConnectFlags = ::Godot::ConnectFlags::None, &block : Array(Variant) -> Void) : SignalSubscription
connect(signal_name : Symbol, flags : Godot::ConnectFlags = ::Godot::ConnectFlags::None, &block : Array(Variant) -> Void) : SignalSubscription
connect(signal_name : String, listener_target : Godot::Object, method_name : Symbol, flags : Godot::ConnectFlags = ::Godot::ConnectFlags::None) : SignalSubscription
connect(signal : String, callable : Pointer(Void), flags : Int64 = 0_i64) : Godot::Error connect, connect_one_shot(signal_name : String, &block : Array(Variant) -> Void) : SignalSubscription connect_one_shot, connected?(signal : String, callable : Pointer(Void)) : Bool connected?, destroy : Void destroy, destroyed? : Bool destroyed?, disconnect(signal : String, callable : Pointer(Void)) : Void
disconnect(signal_name : String) : Void disconnect, editor_hint? : Bool editor_hint?, emit_property_list_changed : Void emit_property_list_changed, emit_script_changed : Void emit_script_changed, emit_signal(name : String) : Void
emit_signal(name : String, *args) : Void emit_signal, explicitly_freed? : Bool explicitly_freed?, free : Void free, get(property : String) : Pointer(Void) get, get_class : String get_class, get_incoming_connections : Pointer(Void) get_incoming_connections, get_indexed(property_path : NodePath | String) : Pointer(Void) get_indexed, get_instance_id : Int64 get_instance_id, get_meta(name : String, default : Pointer(Void) | Nil = nil) : Pointer(Void) get_meta, get_meta_list : Pointer(Void) get_meta_list, get_method_argument_count(method : String) : Int64 get_method_argument_count, get_method_list : Pointer(Void) get_method_list, get_property_list : Pointer(Void) get_property_list, get_script : Pointer(Void) get_script, get_signal_connection_list(signal : String) : Pointer(Void) get_signal_connection_list, get_signal_list : Pointer(Void) get_signal_list, get_translation_domain : String get_translation_domain, has_connections(signal : String) : Bool has_connections, has_connections?(signal : String) : Bool has_connections?, has_meta(name : String) : Bool has_meta, has_meta?(name : String) : Bool has_meta?, has_method(method : String) : Bool has_method, has_method?(method : String) : Bool has_method?, has_signal(signal : String) : Bool has_signal, has_signal?(signal_name : String) : Bool has_signal?, has_user_signal(signal : String) : Bool has_user_signal, has_user_signal?(signal : String) : Bool has_user_signal?, hash(hasher) hash, if_alive : self | Nil if_alive, instance_id : UInt64 instance_id, is_blocking_signals : Bool is_blocking_signals, is_blocking_signals? : Bool is_blocking_signals?, is_class(godot_class : String) : Bool is_class, is_class?(godot_class : String) : Bool is_class?, is_connected(signal : String, callable : Pointer(Void)) : Bool is_connected, is_connected?(signal : String, callable : Pointer(Void)) : Bool is_connected?, is_queued_for_deletion : Bool is_queued_for_deletion, is_queued_for_deletion? : Bool is_queued_for_deletion?, is_valid? : Bool is_valid?, link_class_script : Void link_class_script, notification(what : Int64, reversed : Bool = false) : Void notification, notify_property_list_changed : Void notify_property_list_changed, pointer : Pointer(Void) pointer, pointer=(val : Pointer(Void)) pointer=, print(*args) print, printerr(*args) printerr, property_can_revert(property : String) : Bool property_can_revert, property_can_revert?(property : String) : Bool property_can_revert?, property_get_revert(property : String) : Pointer(Void) property_get_revert, property_list_changed : Godot::TypedSignal() property_list_changed, puts(*args) puts, queued_for_deletion? : Bool queued_for_deletion?, remove_meta(name : String) : Void remove_meta, remove_user_signal(signal : String) : Void remove_user_signal, script_changed : Godot::TypedSignal() script_changed, set(property : String, value : Pointer(Void)) : Void set, set_block_signals(enable : Bool) : Void set_block_signals, set_deferred(property : String, value : Pointer(Void)) : Void set_deferred, set_indexed(property_path : NodePath | String, value : Pointer(Void)) : Void set_indexed, set_message_translation(enable : Bool) : Void set_message_translation, set_meta(name : String, value : Pointer(Void)) : Void set_meta, set_script(script : Pointer(Void)) : Void set_script, set_translation_domain(domain : String) : Void set_translation_domain, signal(name : String) : Godot::BoundSignal
signal(sym : Symbol) : Godot::BoundSignal signal, signal_connection_count(signal_name : String) : Int32 signal_connection_count, signal_target_id : UInt64 signal_target_id, to_s(io : IO) : Void to_s, to_string : String to_string, to_unsafe : Pointer(Void) to_unsafe, tr(message : String, context : String = "") : String tr, tr_n(message : String, plural_message : String, n : Int64, context : String = "") : String tr_n

Constructor methods inherited from class Godot::Object

new(pointer : Pointer(Void) = Pointer(Void).null) new

Class methods inherited from class Godot::Object

_godot_has_virtual_method(method_name : String) : Bool _godot_has_virtual_method, find_script_path_for_class(target_cls : String) : String find_script_path_for_class, is_instance_id_valid(id : Int | UInt64) : Bool is_instance_id_valid

Constructor Detail

def self.new(pointer : Pointer(Void) = Pointer(Void).null) #

Instance Method Detail

def accessibility_enabled? : Bool #

Predicate alias for #is_accessibility_enabled


def accessibility_supported? : Bool #

Predicate alias for #is_accessibility_supported


def auto_accept_quit #

Property #auto_accept_quit getter


def auto_accept_quit=(val) #

Property #auto_accept_quit setter


def auto_accept_quit? : Bool #

Predicate alias for #is_auto_accept_quit


def await_physics_frame : Void #

Cooperatively awaits the next physics frame without halting the engine loop


def await_process_frame : Void #

Cooperatively awaits the next idle frame without halting the engine loop


def change_scene_to_file(path : String) : Godot::Error #

Changes running scene to file at specified path. Enforces thread-safety: off-thread calls raise ThreadAffinityError.


def change_scene_to_node(node : Node) : Godot::Error #

Changes running scene to specified Node. Enforces thread-safety: off-thread calls raise ThreadAffinityError.


def change_scene_to_packed(packed_scene : PackedScene) : Godot::Error #

Changes running scene to specified PackedScene. Enforces thread-safety: off-thread calls raise ThreadAffinityError.


def create_timer(time_sec : Float64, process_always : Bool = true, process_in_physics : Bool = false, ignore_time_scale : Bool = false) : SceneTreeTimer #

def create_timer(time_sec : Int, process_always : Bool = true, process_in_physics : Bool = false, ignore_time_scale : Bool = false) : SceneTreeTimer #

Creates a SceneTreeTimer with integer seconds


def create_tween : Tween #

def current_scene : Node #

def current_scene=(current_scene : Node) #

def debug_collisions_hint #

Property #debug_collisions_hint getter


def debug_collisions_hint=(val) #

Property #debug_collisions_hint setter


def debug_collisions_hint? #

def debug_navigation_hint #

Property #debug_navigation_hint getter


def debug_navigation_hint=(val) #

Property #debug_navigation_hint setter


def debug_navigation_hint? #

def debug_paths_hint #

Property #debug_paths_hint getter


def debug_paths_hint=(val) #

Property #debug_paths_hint setter


def debug_paths_hint? #

def debugging_collisions_hint? : Bool #

Predicate alias for #is_debugging_collisions_hint


def debugging_navigation_hint? : Bool #

Predicate alias for #is_debugging_navigation_hint


def debugging_paths_hint? : Bool #

Predicate alias for #is_debugging_paths_hint


def edited_scene_root #

Property #edited_scene_root getter


def edited_scene_root=(val) #

Property #edited_scene_root setter


def emit_node_added(*args) : Void #

def emit_node_configuration_warning_changed(*args) : Void #

def emit_node_removed(*args) : Void #

def emit_node_renamed(*args) : Void #

def emit_physics_frame : Void #

def emit_process_frame : Void #

def emit_scene_changed : Void #

def emit_tree_changed : Void #

def emit_tree_process_mode_changed : Void #

def get_current_scene : Node #

def get_edited_scene_root : Node #

def get_first_node_in_group(group : String) : Node #

def get_first_node_in_group_as(type : T.class, group_name : String) : T | Nil forall T #

Retrieves the first node in a group cast to wrapper type T


def get_frame : Int64 #

def get_multiplayer(for_path : NodePath | String = "") : MultiplayerAPI #

def get_node_count : Int64 #

def get_node_count_in_group(group : String) : Int64 #

def get_nodes_in_group(group : String) : Pointer(Void) #

def get_processed_tweens : Pointer(Void) #

def get_root : Window #

def has_group(name : String) : Bool #

def has_group?(name : String) : Bool #

Predicate alias for #has_group


def is_accessibility_enabled : Bool #

def is_accessibility_enabled? : Bool #

Predicate alias for #is_accessibility_enabled


def is_accessibility_supported : Bool #

def is_accessibility_supported? : Bool #

Predicate alias for #is_accessibility_supported


def is_auto_accept_quit : Bool #

def is_auto_accept_quit? : Bool #

Predicate alias for #is_auto_accept_quit


def is_debugging_collisions_hint : Bool #

def is_debugging_collisions_hint? : Bool #

Predicate alias for #is_debugging_collisions_hint


def is_debugging_navigation_hint : Bool #

def is_debugging_navigation_hint? : Bool #

Predicate alias for #is_debugging_navigation_hint


def is_debugging_paths_hint : Bool #

def is_debugging_paths_hint? : Bool #

Predicate alias for #is_debugging_paths_hint


def is_multiplayer_poll_enabled : Bool #

def is_multiplayer_poll_enabled? : Bool #

Predicate alias for #is_multiplayer_poll_enabled


def is_paused : Bool #

def is_paused? : Bool #

Predicate alias for #is_paused


def is_physics_interpolation_enabled : Bool #

def is_physics_interpolation_enabled? : Bool #

Predicate alias for #is_physics_interpolation_enabled


def is_quit_on_go_back : Bool #

def is_quit_on_go_back? : Bool #

Predicate alias for #is_quit_on_go_back


def multiplayer_poll #

Property #multiplayer_poll getter


def multiplayer_poll=(val) #

Property #multiplayer_poll setter


def multiplayer_poll? #

def multiplayer_poll_enabled? : Bool #

Predicate alias for #is_multiplayer_poll_enabled


def node_added : Godot::TypedSignal(Node) #

def node_configuration_warning_changed : Godot::TypedSignal(Node) #

def node_removed : Godot::TypedSignal(Node) #

def node_renamed : Godot::TypedSignal(Node) #

def notify_group(group : String, notification : Int64) : Void #

def notify_group_flags(call_flags : Int64, group : String, notification : Int64) : Void #

def paused #

Property #paused getter


def paused=(val) #

Property #paused setter


def paused? : Bool #

Predicate alias for #is_paused


def physics_frame : Godot::TypedSignal() #

def physics_interpolation #

Property #physics_interpolation getter


def physics_interpolation=(val) #

Property #physics_interpolation setter


def physics_interpolation? #

def physics_interpolation_enabled? : Bool #

Predicate alias for #is_physics_interpolation_enabled


def process_frame : Godot::TypedSignal() #

def queue_delete(obj : Godot::Object) : Void #

def quit(exit_code : Int64 = 0_i64) : Void #

def quit_on_go_back #

Property #quit_on_go_back getter


def quit_on_go_back=(val) #

Property #quit_on_go_back setter


def quit_on_go_back? : Bool #

Predicate alias for #is_quit_on_go_back


def reload_current_scene : Godot::Error #

Reloads currently running scene. Enforces thread-safety: off-thread calls raise ThreadAffinityError.


def root : Node #

def root=(root : Node) #

def scene_changed : Godot::TypedSignal() #

def set_auto_accept_quit(enabled : Bool) : Void #

def set_current_scene(child_node : Node) : Void #

def set_debug_collisions_hint(enable : Bool) : Void #

def set_debug_navigation_hint(enable : Bool) : Void #

def set_debug_paths_hint(enable : Bool) : Void #

def set_edited_scene_root(scene : Node) : Void #

def set_group(group : String, property : String, value : Pointer(Void)) : Void #

def set_group_flags(call_flags : Int64, group : String, property : String, value : Pointer(Void)) : Void #

def set_multiplayer(multiplayer : MultiplayerAPI, root_path : NodePath | String = "") : Void #

def set_multiplayer_poll_enabled(enabled : Bool) : Void #

def set_pause(enable : Bool) : Void #

def set_physics_interpolation_enabled(enabled : Bool) : Void #

def set_quit_on_go_back(enabled : Bool) : Void #

def tree_changed : Godot::TypedSignal() #

def tree_process_mode_changed : Godot::TypedSignal() #

def unload_current_scene : Void #

Unloads currently running scene. Enforces thread-safety: off-thread calls raise ThreadAffinityError.