#[repr(C)]pub struct Engine { /* private fields */ }Expand description
Godot class Engine.
Inherits Object.
Related symbols:
IEngine: virtual methods
See also Godot docs for Engine.
§Singleton
This class is a singleton. You can get the one instance using Engine::singleton().
Implementations§
§impl Engine
impl Engine
pub fn singleton() -> Gd<Engine>
pub fn set_physics_ticks_per_second(&mut self, physics_ticks_per_second: i32)
pub fn get_physics_ticks_per_second(&self) -> i32
pub fn set_max_physics_steps_per_frame(&mut self, max_physics_steps: i32)
pub fn get_max_physics_steps_per_frame(&self) -> i32
pub fn set_physics_jitter_fix(&mut self, physics_jitter_fix: f64)
pub fn get_physics_jitter_fix(&self) -> f64
pub fn get_physics_interpolation_fraction(&self) -> f64
pub fn set_max_fps(&mut self, max_fps: i32)
pub fn get_max_fps(&self) -> i32
pub fn set_time_scale(&mut self, time_scale: f64)
pub fn get_time_scale(&mut self) -> f64
pub fn get_frames_drawn(&mut self) -> i32
pub fn get_frames_per_second(&self) -> f64
pub fn get_physics_frames(&self) -> u64
pub fn get_process_frames(&self) -> u64
pub fn get_main_loop(&self) -> Option<Gd<MainLoop>>
pub fn get_version_info(&self) -> Dictionary
pub fn get_copyright_info(&self) -> Array<Dictionary>
pub fn get_donor_info(&self) -> Dictionary
pub fn get_license_info(&self) -> Dictionary
pub fn get_license_text(&self) -> GString
pub fn get_architecture_name(&self) -> GString
pub fn is_in_physics_frame(&self) -> bool
pub fn has_singleton(&self, name: StringName) -> bool
pub fn get_singleton(&self, name: StringName) -> Option<Gd<Object>>
pub fn register_singleton(&mut self, name: StringName, instance: Gd<Object>)
pub fn unregister_singleton(&mut self, name: StringName)
pub fn get_singleton_list(&self) -> PackedStringArray
pub fn register_script_language( &mut self, language: Gd<ScriptLanguage> ) -> Error
pub fn unregister_script_language( &mut self, language: Gd<ScriptLanguage> ) -> Error
pub fn get_script_language_count(&mut self) -> i32
pub fn get_script_language(&self, index: i32) -> Option<Gd<ScriptLanguage>>
pub fn is_editor_hint(&self) -> bool
pub fn get_write_movie_path(&self) -> GString
pub fn set_print_error_messages(&mut self, enabled: bool)
pub fn is_printing_error_messages(&self) -> bool
Methods from Deref<Target = Object>§
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: GString) -> bool
pub fn set(&mut self, property: StringName, value: Variant)
pub fn get(&self, property: StringName) -> Variant
pub fn set_indexed(&mut self, property_path: NodePath, value: Variant)
pub fn get_indexed(&self, property_path: NodePath) -> Variant
pub fn get_property_list(&self) -> Array<Dictionary>
pub fn get_method_list(&self) -> Array<Dictionary>
pub fn property_can_revert(&self, property: StringName) -> bool
pub fn property_get_revert(&self, property: StringName) -> Variant
pub fn set_script(&mut self, script: Variant)
pub fn get_script(&self) -> Variant
pub fn set_meta(&mut self, name: StringName, value: Variant)
pub fn remove_meta(&mut self, name: StringName)
pub fn get_meta(&self, name: StringName) -> Variant
pub fn get_meta_ex(&self, name: StringName) -> ExGetMeta<'_>
pub fn has_meta(&self, name: StringName) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: GString)
pub fn add_user_signal_ex(&mut self, signal: GString) -> ExAddUserSignal<'_>
pub fn has_user_signal(&self, signal: StringName) -> bool
pub fn remove_user_signal(&mut self, signal: StringName)
pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error
pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will panic in such a case.
pub fn try_emit_signal(
&mut self,
signal: StringName,
varargs: &[Variant]
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant] ) -> Result<Error, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will return Err in such a case.
pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant
pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will panic in such a case.
pub fn try_call(
&mut self,
method: StringName,
varargs: &[Variant]
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: StringName, varargs: &[Variant] ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will return Err in such a case.
pub fn call_deferred(
&mut self,
method: StringName,
varargs: &[Variant]
) -> Variant
pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant] ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will panic in such a case.
pub fn try_call_deferred(
&mut self,
method: StringName,
varargs: &[Variant]
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant] ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will return Err in such a case.
pub fn set_deferred(&mut self, property: StringName, value: Variant)
pub fn callv( &mut self, method: StringName, arg_array: Array<Variant> ) -> Variant
pub fn has_method(&self, method: StringName) -> bool
pub fn get_method_argument_count(&self, method: StringName) -> i32
pub fn has_signal(&self, signal: StringName) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: StringName ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error
pub fn connect_ex( &mut self, signal: StringName, callable: Callable ) -> ExConnect<'_>
pub fn disconnect(&mut self, signal: StringName, callable: Callable)
pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool
pub fn set_block_signals(&mut self, enable: bool)
pub fn is_blocking_signals(&self) -> bool
pub fn notify_property_list_changed(&mut self)
pub fn set_message_translation(&mut self, enable: bool)
pub fn can_translate_messages(&self) -> bool
pub fn tr(&self, message: StringName) -> GString
pub fn tr_ex(&self, message: StringName) -> ExTr<'_>
pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32 ) -> GString
pub fn tr_n_ex( &self, message: StringName, plural_message: StringName, n: i32 ) -> ExTrN<'_>
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
pub fn notify(&mut self, what: ObjectNotification)
⚠️ Sends a Godot notification to all classes inherited by the object.
Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().
Starts from the highest ancestor (the Object class) and goes down the hierarchy.
See also Godot docs for Object::notification().
§Panics
If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter
a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must
be exclusive.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.