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

OS

gdext.classes.OS
See theOS companion object
abstract class OS extends Object

Generated wrapper for Godot's OS, extends Object.

Attributes

Companion
object
Graph
Supertypes
class Object
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

final def addLogger(logger: Logger): Unit

OS.add_logger

OS.add_logger

Attributes

final def alert(text: String, title: String): Unit

OS.alert

OS.alert

Attributes

final def closeMidiInputs(): Unit

OS.close_midi_inputs

OS.close_midi_inputs

Attributes

final def crash(message: String): Unit

OS.crash

OS.crash

Attributes

final def delayMsec(msec: Long): Unit

OS.delay_msec

OS.delay_msec

Attributes

final def delayUsec(usec: Long): Unit

OS.delay_usec

OS.delay_usec

Attributes

final def findKeycodeFromString(string: String): Long

OS.find_keycode_from_string

OS.find_keycode_from_string

Attributes

final def getCacheDir(): String

OS.get_cache_dir

OS.get_cache_dir

Attributes

final def getConfigDir(): String

OS.get_config_dir

OS.get_config_dir

Attributes

final def getDataDir(): String

OS.get_data_dir

OS.get_data_dir

Attributes

final def getDistributionName(): String

OS.get_distribution_name

OS.get_distribution_name

Attributes

final def getEnvironment(variable: String): String

OS.get_environment

OS.get_environment

Attributes

final def getExecutablePath(): String

OS.get_executable_path

OS.get_executable_path

Attributes

final def getKeycodeString(code: Long): String

OS.get_keycode_string

OS.get_keycode_string

Attributes

final def getLocale(): String

OS.get_locale

OS.get_locale

Attributes

final def getLocaleLanguage(): String

OS.get_locale_language

OS.get_locale_language

Attributes

final def getLowProcessorUsageModeSleepUsec(): Long

OS.get_low_processor_usage_mode_sleep_usec

OS.get_low_processor_usage_mode_sleep_usec

Attributes

final def getMainThreadId(): Long

OS.get_main_thread_id

OS.get_main_thread_id

Attributes

final def getModelName(): String

OS.get_model_name

OS.get_model_name

Attributes

final def getName(): String

OS.get_name

OS.get_name

Attributes

final def getProcessExitCode(pid: Long): Long

OS.get_process_exit_code

OS.get_process_exit_code

Attributes

final def getProcessId(): Long

OS.get_process_id

OS.get_process_id

Attributes

final def getProcessorCount(): Long

OS.get_processor_count

OS.get_processor_count

Attributes

final def getProcessorName(): String

OS.get_processor_name

OS.get_processor_name

Attributes

final def getStaticMemoryPeakUsage(): Long

OS.get_static_memory_peak_usage

OS.get_static_memory_peak_usage

Attributes

final def getStaticMemoryUsage(): Long

OS.get_static_memory_usage

OS.get_static_memory_usage

Attributes

final def getStderrType(): Long

OS.get_stderr_type

OS.get_stderr_type

Attributes

final def getStdinType(): Long

OS.get_stdin_type

OS.get_stdin_type

Attributes

final def getStdoutType(): Long

OS.get_stdout_type

OS.get_stdout_type

Attributes

final def getSystemCaCertificates(): String

OS.get_system_ca_certificates

OS.get_system_ca_certificates

Attributes

final def getSystemDir(dir: Long, shared_storage: Boolean): String

OS.get_system_dir

OS.get_system_dir

Attributes

final def getSystemFontPath(font_name: String, weight: Long, stretch: Long, italic: Boolean): String

OS.get_system_font_path

OS.get_system_font_path

Attributes

final def getTempDir(): String

OS.get_temp_dir

OS.get_temp_dir

Attributes

final def getThreadCallerId(): Long

OS.get_thread_caller_id

OS.get_thread_caller_id

Attributes

final def getUniqueId(): String

OS.get_unique_id

OS.get_unique_id

Attributes

final def getUserDataDir(): String

OS.get_user_data_dir

OS.get_user_data_dir

Attributes

final def getVersion(): String

OS.get_version

OS.get_version

Attributes

final def getVersionAlias(): String

OS.get_version_alias

OS.get_version_alias

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 hasEnvironment(variable: String): Boolean

OS.has_environment

OS.has_environment

Attributes

final def hasFeature(tag_name: String): Boolean

OS.has_feature

OS.has_feature

Attributes

final def isDebugBuild(): Boolean

OS.is_debug_build

OS.is_debug_build

Attributes

final def isDeltaSmoothingEnabled(): Boolean

OS.is_delta_smoothing_enabled

OS.is_delta_smoothing_enabled

Attributes

final def isInLowProcessorUsageMode(): Boolean

OS.is_in_low_processor_usage_mode

OS.is_in_low_processor_usage_mode

Attributes

final def isKeycodeUnicode(code: Long): Boolean

OS.is_keycode_unicode

OS.is_keycode_unicode

Attributes

final def isProcessRunning(pid: Long): Boolean

OS.is_process_running

OS.is_process_running

Attributes

final def isRestartOnExitSet(): Boolean

OS.is_restart_on_exit_set

OS.is_restart_on_exit_set

Attributes

final def isSandboxed(): Boolean

OS.is_sandboxed

OS.is_sandboxed

Attributes

final def isStdoutVerbose(): Boolean

OS.is_stdout_verbose

OS.is_stdout_verbose

Attributes

final def isUserfsPersistent(): Boolean

OS.is_userfs_persistent

OS.is_userfs_persistent

Attributes

final def kill(pid: Long): Long

OS.kill

OS.kill

Attributes

final def moveToTrash(path: String): Long

OS.move_to_trash

OS.move_to_trash

Attributes

final def openMidiInputs(): Unit

OS.open_midi_inputs

OS.open_midi_inputs

Attributes

final def readStringFromStdin(buffer_size: Long): String

OS.read_string_from_stdin

OS.read_string_from_stdin

Attributes

final def removeLogger(logger: Logger): Unit

OS.remove_logger

OS.remove_logger

Attributes

final def requestPermission(name: String): Boolean

OS.request_permission

OS.request_permission

Attributes

final def requestPermissions(): Boolean

OS.request_permissions

OS.request_permissions

Attributes

final def revokeGrantedPermissions(): Unit

OS.revoke_granted_permissions

OS.revoke_granted_permissions

Attributes

final def setDeltaSmoothing(delta_smoothing_enabled: Boolean): Unit

OS.set_delta_smoothing

OS.set_delta_smoothing

Attributes

final def setEnvironment(variable: String, value: String): Unit

OS.set_environment

OS.set_environment

Attributes

final def setLowProcessorUsageMode(enable: Boolean): Unit

OS.set_low_processor_usage_mode

OS.set_low_processor_usage_mode

Attributes

final def setLowProcessorUsageModeSleepUsec(usec: Long): Unit

OS.set_low_processor_usage_mode_sleep_usec

OS.set_low_processor_usage_mode_sleep_usec

Attributes

final def setThreadName(name: String): Long

OS.set_thread_name

OS.set_thread_name

Attributes

final def setUseFileAccessSaveAndSwap(enabled: Boolean): Unit

OS.set_use_file_access_save_and_swap

OS.set_use_file_access_save_and_swap

Attributes

final def shellOpen(uri: String): Long

OS.shell_open

OS.shell_open

Attributes

final def shellShowInFileManager(file_or_dir_path: String, open_folder: Boolean): Long

OS.shell_show_in_file_manager

OS.shell_show_in_file_manager

Attributes

final def unsetEnvironment(variable: String): Unit

OS.unset_environment

OS.unset_environment

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