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

Engine

gdext.classes.Engine
See theEngine companion object
abstract class Engine extends Object

Generated wrapper for Godot's Engine, extends Object.

Attributes

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

Members list

Value members

Concrete methods

final def getArchitectureName(): String

Engine.get_architecture_name

Engine.get_architecture_name

Attributes

final def getFramesDrawn(): Long

Engine.get_frames_drawn

Engine.get_frames_drawn

Attributes

final def getFramesPerSecond(): Double

Engine.get_frames_per_second

Engine.get_frames_per_second

Attributes

final def getLicenseText(): String

Engine.get_license_text

Engine.get_license_text

Attributes

final def getMainLoop(): MainLoop

Engine.get_main_loop

Engine.get_main_loop

Attributes

final def getMaxFps(): Long

Engine.get_max_fps

Engine.get_max_fps

Attributes

final def getMaxPhysicsStepsPerFrame(): Long

Engine.get_max_physics_steps_per_frame

Engine.get_max_physics_steps_per_frame

Attributes

final def getPhysicsFrames(): Long

Engine.get_physics_frames

Engine.get_physics_frames

Attributes

final def getPhysicsInterpolationFraction(): Double

Engine.get_physics_interpolation_fraction

Engine.get_physics_interpolation_fraction

Attributes

final def getPhysicsJitterFix(): Double

Engine.get_physics_jitter_fix

Engine.get_physics_jitter_fix

Attributes

final def getPhysicsTicksPerSecond(): Long

Engine.get_physics_ticks_per_second

Engine.get_physics_ticks_per_second

Attributes

final def getProcessFrames(): Long

Engine.get_process_frames

Engine.get_process_frames

Attributes

final def getScriptLanguage(index: Long): ScriptLanguage

Engine.get_script_language

Engine.get_script_language

Attributes

final def getScriptLanguageCount(): Long

Engine.get_script_language_count

Engine.get_script_language_count

Attributes

final def getSingleton(name: StringName): Object

Engine.get_singleton

Engine.get_singleton

Attributes

final def getTimeScale(): Double

Engine.get_time_scale

Engine.get_time_scale

Attributes

final def getWriteMoviePath(): String

Engine.get_write_movie_path

Engine.get_write_movie_path

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 hasSingleton(name: StringName): Boolean

Engine.has_singleton

Engine.has_singleton

Attributes

final def isEditorHint(): Boolean

Engine.is_editor_hint

Engine.is_editor_hint

Attributes

final def isEmbeddedInEditor(): Boolean

Engine.is_embedded_in_editor

Engine.is_embedded_in_editor

Attributes

final def isInPhysicsFrame(): Boolean

Engine.is_in_physics_frame

Engine.is_in_physics_frame

Attributes

final def isPrintingErrorMessages(): Boolean

Engine.is_printing_error_messages

Engine.is_printing_error_messages

Attributes

final def isPrintingToStdout(): Boolean

Engine.is_printing_to_stdout

Engine.is_printing_to_stdout

Attributes

final def registerScriptLanguage(language: ScriptLanguage): Long

Engine.register_script_language

Engine.register_script_language

Attributes

final def registerSingleton(name: StringName, instance: Object): Unit

Engine.register_singleton

Engine.register_singleton

Attributes

final def setMaxFps(max_fps: Long): Unit

Engine.set_max_fps

Engine.set_max_fps

Attributes

final def setMaxPhysicsStepsPerFrame(max_physics_steps: Long): Unit

Engine.set_max_physics_steps_per_frame

Engine.set_max_physics_steps_per_frame

Attributes

final def setPhysicsJitterFix(physics_jitter_fix: Double): Unit

Engine.set_physics_jitter_fix

Engine.set_physics_jitter_fix

Attributes

final def setPhysicsTicksPerSecond(physics_ticks_per_second: Long): Unit

Engine.set_physics_ticks_per_second

Engine.set_physics_ticks_per_second

Attributes

final def setPrintErrorMessages(enabled: Boolean): Unit

Engine.set_print_error_messages

Engine.set_print_error_messages

Attributes

final def setPrintToStdout(enabled: Boolean): Unit

Engine.set_print_to_stdout

Engine.set_print_to_stdout

Attributes

final def setTimeScale(time_scale: Double): Unit

Engine.set_time_scale

Engine.set_time_scale

Attributes

final def unregisterScriptLanguage(language: ScriptLanguage): Long

Engine.unregister_script_language

Engine.unregister_script_language

Attributes

final def unregisterSingleton(name: StringName): Unit

Engine.unregister_singleton

Engine.unregister_singleton

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