class Godot::OS

Overview

Godot OS singleton (OS).

Defined in:

libgodot/generated/classes/classes_part3.cr
libgodot/generated/singletons.cr

Constructors

Class Method Summary

Instance Method Summary

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.instance : OS #

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

Class Method Detail

def self.singleton_ptr : Pointer(Void) #

Instance Method Detail

def add_logger(logger : Logger) : Void #

def alert(text : String, title : String = "Alert!") : Void #

def close_midi_inputs : Void #

def crash(message : String) : Void #

def create_instance(arguments : Pointer(Void)) : Int64 #

def create_process(path : String, arguments : Pointer(Void), open_console : Bool = false) : Int64 #

def debug_build? : Bool #

Predicate alias for #is_debug_build


def delay_msec(msec : Int64) : Void #

def delay_usec(usec : Int64) : Void #

def delta_smoothing #

Property #delta_smoothing getter


def delta_smoothing=(val) #

Property #delta_smoothing setter


def delta_smoothing? #

def delta_smoothing_enabled? : Bool #

Predicate alias for #is_delta_smoothing_enabled


def execute(path : String, arguments : Pointer(Void), output : Pointer(Void), read_stderr : Bool = false, open_console : Bool = false) : Int64 #

def execute_with_pipe(path : String, arguments : Pointer(Void), blocking : Bool = true) : Pointer(Void) #

def find_keycode_from_string(string : String) : Godot::Key #

def get_cache_dir : String #

def get_cmdline_args : Pointer(Void) #

def get_cmdline_user_args : Pointer(Void) #

def get_config_dir : String #

def get_connected_midi_inputs : Pointer(Void) #

def get_data_dir : String #

def get_distribution_name : String #

def get_entropy(size : Int64) : Pointer(Void) #

def get_environment(variable : String) : String #

def get_executable_path : String #

def get_granted_permissions : Pointer(Void) #

def get_keycode_string(code : Godot::Key | Int) : String #

def get_locale : String #

def get_locale_language : String #

def get_low_processor_usage_mode_sleep_usec : Int64 #

def get_main_thread_id : Int64 #

def get_memory_info : Pointer(Void) #

def get_model_name : String #

def get_name : String #

def get_preferred_locales : Pointer(Void) #

def get_process_exit_code(pid : Int64) : Int64 #

def get_process_id : Int64 #

def get_processor_count : Int64 #

def get_processor_name : String #

def get_restart_on_exit_arguments : Pointer(Void) #

def get_static_memory_peak_usage : Int64 #

def get_static_memory_usage : Int64 #

def get_stderr_type : StdHandleType #

def get_stdin_type : StdHandleType #

def get_stdout_type : StdHandleType #

def get_system_ca_certificates : String #

def get_system_dir(dir : SystemDir | Int, shared_storage : Bool = true) : String #

def get_system_font_path(font_name : String, weight : Int64 = 400_i64, stretch : Int64 = 100_i64, italic : Bool = false) : String #

def get_system_font_path_for_text(font_name : String, text : String, locale : String = "", script : String = "", weight : Int64 = 400_i64, stretch : Int64 = 100_i64, italic : Bool = false) : Pointer(Void) #

def get_system_fonts : Pointer(Void) #

def get_temp_dir : String #

def get_thread_caller_id : Int64 #

def get_unique_id : String #

def get_user_data_dir : String #

def get_version : String #

def get_version_alias : String #

def get_video_adapter_driver_info : Pointer(Void) #

def has_environment(variable : String) : Bool #

def has_environment?(variable : String) : Bool #

Predicate alias for #has_environment


def has_feature(tag_name : String) : Bool #

def has_feature?(tag_name : String) : Bool #

Predicate alias for #has_feature


def in_low_processor_usage_mode? : Bool #

Predicate alias for #is_in_low_processor_usage_mode


def is_debug_build : Bool #

def is_debug_build? : Bool #

Predicate alias for #is_debug_build


def is_delta_smoothing_enabled : Bool #

def is_delta_smoothing_enabled? : Bool #

Predicate alias for #is_delta_smoothing_enabled


def is_in_low_processor_usage_mode : Bool #

def is_in_low_processor_usage_mode? : Bool #

Predicate alias for #is_in_low_processor_usage_mode


def is_keycode_unicode(code : Int64) : Bool #

def is_keycode_unicode?(code : Int64) : Bool #

Predicate alias for #is_keycode_unicode


def is_process_running(pid : Int64) : Bool #

def is_process_running?(pid : Int64) : Bool #

Predicate alias for #is_process_running


def is_restart_on_exit_set : Bool #

def is_restart_on_exit_set? : Bool #

Predicate alias for #is_restart_on_exit_set


def is_sandboxed : Bool #

def is_sandboxed? : Bool #

Predicate alias for #is_sandboxed


def is_stdout_verbose : Bool #

def is_stdout_verbose? : Bool #

Predicate alias for #is_stdout_verbose


def is_userfs_persistent : Bool #

def is_userfs_persistent? : Bool #

Predicate alias for #is_userfs_persistent


def keycode_unicode?(code : Int64) : Bool #

Predicate alias for #is_keycode_unicode


def kill(pid : Int64) : Godot::Error #

def low_processor_usage_mode #

Property #low_processor_usage_mode getter


def low_processor_usage_mode=(val) #

Property #low_processor_usage_mode setter


def low_processor_usage_mode? #

def low_processor_usage_mode_sleep_usec #

Property #low_processor_usage_mode_sleep_usec getter


def low_processor_usage_mode_sleep_usec=(val : Int) #

Property #low_processor_usage_mode_sleep_usec setter


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

def open_midi_inputs : Void #

def open_with_program(program_path : String, paths : Pointer(Void)) : Godot::Error #

def process_running?(pid : Int64) : Bool #

Predicate alias for #is_process_running


def read_buffer_from_stdin(buffer_size : Int64 = 1024_i64) : Pointer(Void) #

def read_string_from_stdin(buffer_size : Int64 = 1024_i64) : String #

def remove_logger(logger : Logger) : Void #

def request_permission(name : String) : Bool #

def request_permission?(name : String) : Bool #

Predicate alias for #request_permission


def request_permissions : Bool #

def request_permissions? : Bool #

Predicate alias for #request_permissions


def restart_on_exit_set? : Bool #

Predicate alias for #is_restart_on_exit_set


def revoke_granted_permissions : Void #

def sandboxed? : Bool #

Predicate alias for #is_sandboxed


def set_delta_smoothing(delta_smoothing_enabled : Bool) : Void #

def set_environment(variable : String, value : String) : Void #

def set_low_processor_usage_mode(enable : Bool) : Void #

def set_low_processor_usage_mode_sleep_usec(usec : Int64) : Void #

def set_restart_on_exit(restart : Bool, arguments : Pointer(Void)) : Void #

def set_thread_name(name : String) : Godot::Error #

def set_use_file_access_save_and_swap(enabled : Bool) : Void #

def shell_open(uri : String) : Godot::Error #

def shell_show_in_file_manager(file_or_dir_path : String, open_folder : Bool = true) : Godot::Error #

def stdout_verbose? : Bool #

Predicate alias for #is_stdout_verbose


def unset_environment(variable : String) : Void #

def userfs_persistent? : Bool #

Predicate alias for #is_userfs_persistent