Struct Engine

pub struct Engine { /* private fields */ }

Expand description

Godot class Engine.

Inherits Object.

Related symbols:

engine: sidecar module with related enum/flag types

§Singleton

This class is a singleton. You can get the one instance using Singleton::singleton().

§Final class

This class is final, meaning you cannot inherit from it, and it comes without I* interface trait. It is still possible that other Godot classes inherit from it, but that is limited to the engine itself.

§Godot docs

The Engine singleton allows you to query and modify the project’s run-time parameters, such as frames per second, time scale, and others. It also stores information about the current build of Godot, such as the current version.

Implementations§

§

impl 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

Returns the fraction through the current physics tick we are at the time of rendering the frame. This can be used to implement fixed timestep interpolation.

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(&self) -> f64

pub fn get_frames_drawn(&self) -> i32

Returns the total number of frames drawn since the engine started.

Note: On headless platforms, or if rendering is disabled with --disable-render-loop via command line, this method always returns 0. See also get_process_frames.

pub fn get_frames_per_second(&self) -> f64

Returns the average frames rendered every second (FPS), also known as the framerate.

pub fn get_physics_frames(&self) -> u64

Returns the total number of frames passed since the engine started. This number is increased every physics frame. See also get_process_frames.

This method can be used to run expensive logic less often without relying on a Timer:

func _physics_process(_delta):
	if Engine.get_physics_frames() % 2 == 0:
		pass # Run expensive logic only once every 2 physics frames here.

pub fn get_process_frames(&self) -> u64

Returns the total number of frames passed since the engine started. This number is increased every process frame, regardless of whether the render loop is enabled. See also get_frames_drawn and get_physics_frames.

This method can be used to run expensive logic less often without relying on a Timer:

func _process(_delta):
	if Engine.get_process_frames() % 5 == 0:
		pass # Run expensive logic only once every 5 process (render) frames here.

pub fn get_main_loop(&self) -> Option<Gd<MainLoop>>

Returns the instance of the MainLoop. This is usually the main SceneTree and is the same as get_tree.

Note: The type instantiated as the main loop can changed with [member ProjectSettings.application/run/main_loop_type].

pub fn get_version_info(&self) -> Dictionary<Variant, Variant>

Returns the current engine version information as a Dictionary containing the following entries:

major - Major version number as an int;
minor - Minor version number as an int;
patch - Patch version number as an int;
hex - Full version encoded as a hexadecimal int with one byte (2 hex digits) per number (see example below);
status - Status (such as “beta”, “rc1”, “rc2”, “stable”, etc.) as a String;
build - Build name (e.g. “custom_build”) as a String;
hash - Full Git commit hash as a String;
timestamp - Holds the Git commit date UNIX timestamp in seconds as an int, or 0 if unavailable;
string - major, minor, patch, status, and build in a single String.

The hex value is encoded as follows, from left to right: one byte for the major, one byte for the minor, one byte for the patch version. For example, “3.1.12” would be 0x03010C.

Note: The hex value is still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for quick version comparisons from code:

if Engine.get_version_info().hex >= 0x040100:
	pass # Do things specific to version 4.1 or later.
else:
	pass # Do things specific to versions before 4.1.

pub fn get_author_info(&self) -> Dictionary<Variant, Variant>

Returns the engine author information as a Dictionary, where each entry is an Array of strings with the names of notable contributors to the Godot Engine: lead_developers, founders, project_managers, and developers.

pub fn get_copyright_info(&self) -> Array<Dictionary<Variant, Variant>>

Returns an Array of dictionaries with copyright information for every component of Godot’s source code.

Every Dictionary contains a name identifier, and a parts array of dictionaries. It describes the component in detail with the following entries:

files - Array of file paths from the source code affected by this component;
copyright - Array of owners of this component;
license - The license applied to this component (such as “Expat” or “CC-BY-4.0”).

pub fn get_donor_info(&self) -> Dictionary<Variant, Variant>

Returns a Dictionary of categorized donor names. Each entry is an Array of strings:

{platinum_sponsors, gold_sponsors, silver_sponsors, bronze_sponsors, mini_sponsors, gold_donors, silver_donors, bronze_donors}

pub fn get_license_info(&self) -> Dictionary<Variant, Variant>

Returns a Dictionary of licenses used by Godot and included third party components. Each entry is a license name (such as “Expat”) and its associated text.

pub fn get_license_text(&self) -> GString

Returns the full Godot license text.

pub fn get_architecture_name(&self) -> GString

Returns the name of the CPU architecture the Godot binary was built for. Possible return values include "x86_64", "x86_32", "arm64", "arm32", "rv64", "ppc64", "loongarch64", "wasm64", and "wasm32".

To detect whether the current build is 64-bit, or the type of architecture, don’t use the architecture name. Instead, use has_feature to check for the "64" feature tag, or tags such as "x86" or "arm". See the Feature Tags documentation for more details.

Note: This method does not return the name of the system’s CPU architecture (like get_processor_name). For example, when running an x86_32 Godot binary on an x86_64 system, the returned value will still be "x86_32".

pub fn is_in_physics_frame(&self) -> bool

Returns true if the engine is inside the fixed physics process step of the main loop.

func _enter_tree():
	# Depending on when the node is added to the tree,
	# prints either "true" or "false".
	print(Engine.is_in_physics_frame())

func _process(delta):
	print(Engine.is_in_physics_frame()) # Prints false

func _physics_process(delta):
	print(Engine.is_in_physics_frame()) # Prints true

pub fn has_singleton(&self, name: impl AsArg<StringName>) -> bool

Returns true if a singleton with the given name exists in the global scope. See also get_singleton.

print(Engine.has_singleton("OS"))          # Prints true
print(Engine.has_singleton("Engine"))      # Prints true
print(Engine.has_singleton("AudioServer")) # Prints true
print(Engine.has_singleton("Unknown"))     # Prints false

Note: Global singletons are not the same as autoloaded nodes, which are configurable in the project settings.

pub fn get_singleton(&self, name: impl AsArg<StringName>) -> Option<Gd<Object>>

Returns the global singleton with the given name, or null if it does not exist. Often used for plugins. See also has_singleton and get_singleton_list.

Note: Global singletons are not the same as autoloaded nodes, which are configurable in the project settings.

pub fn register_singleton( &mut self, name: impl AsArg<StringName>, instance: impl AsArg<Option<Gd<Object>>>, )

Registers the given Object instance as a singleton, available globally under name. Useful for plugins.

pub fn unregister_singleton(&mut self, name: impl AsArg<StringName>)

Removes the singleton registered under name. The singleton object is not freed. Only works with user-defined singletons registered with register_singleton.

pub fn get_singleton_list(&self) -> PackedArray<GString>

Returns a list of names of all available global singletons. See also get_singleton.

pub fn register_script_language( &mut self, language: impl AsArg<Option<Gd<ScriptLanguage>>>, ) -> Error

Registers a ScriptLanguage instance to be available with ScriptServer.

Returns:

Error::OK on success;
Error::ERR_UNAVAILABLE if ScriptServer has reached the limit and cannot register any new language;
Error::ERR_ALREADY_EXISTS if ScriptServer already contains a language with similar extension/name/type.

pub fn unregister_script_language( &mut self, language: impl AsArg<Option<Gd<ScriptLanguage>>>, ) -> Error

Unregisters the ScriptLanguage instance from ScriptServer.

Returns:

Error::OK on success;
Error::ERR_DOES_NOT_EXIST if the language is not registered in ScriptServer.

pub fn get_script_language_count(&self) -> i32

Returns the number of available script languages. Use with get_script_language.

pub fn get_script_language(&self, index: i32) -> Option<Gd<ScriptLanguage>>

Returns an instance of a ScriptLanguage with the given index.

pub fn capture_script_backtraces(&self) -> Array<Gd<ScriptBacktrace>>

To set the default parameters, use capture_script_backtraces_ex and its builder methods. See the book for detailed usage instructions. Captures and returns backtraces from all registered script languages.

By default, the returned ScriptBacktrace will only contain stack frames in editor builds and debug builds. To enable them for release builds as well, you need to enable [member ProjectSettings.debug/settings/gdscript/always_track_call_stacks].

If include_variables is true, the backtrace will also include the names and values of any global variables (e.g. autoload singletons) at the point of the capture, as well as local variables and class member variables at each stack frame. This will however will only be respected when running the game with a debugger attached, like when running the game from the editor. To enable it for export builds as well, you need to enable [member ProjectSettings.debug/settings/gdscript/always_track_local_variables].

Warning: When include_variables is true, any captured variables can potentially (e.g. with GDScript backtraces) be their actual values, including any object references. This means that storing such a ScriptBacktrace will prevent those objects from being deallocated, so it’s generally recommended not to do so.

pub fn capture_script_backtraces_ex<'ex>( &'ex self, ) -> ExCaptureScriptBacktraces<'ex>

Captures and returns backtraces from all registered script languages.

By default, the returned ScriptBacktrace will only contain stack frames in editor builds and debug builds. To enable them for release builds as well, you need to enable [member ProjectSettings.debug/settings/gdscript/always_track_call_stacks].

If include_variables is true, the backtrace will also include the names and values of any global variables (e.g. autoload singletons) at the point of the capture, as well as local variables and class member variables at each stack frame. This will however will only be respected when running the game with a debugger attached, like when running the game from the editor. To enable it for export builds as well, you need to enable [member ProjectSettings.debug/settings/gdscript/always_track_local_variables].

Warning: When include_variables is true, any captured variables can potentially (e.g. with GDScript backtraces) be their actual values, including any object references. This means that storing such a ScriptBacktrace will prevent those objects from being deallocated, so it’s generally recommended not to do so.

pub fn is_editor_hint(&self) -> bool

Returns true if the script is currently running inside the editor, otherwise returns false. This is useful for @tool scripts to conditionally draw editor helpers, or prevent accidentally running “game” code that would affect the scene state while in the editor:

if Engine.is_editor_hint():
	draw_gizmos()
else:
	simulate_physics()

See Running code in the editor in the documentation for more information.

Note: To detect whether the script is running on an editor build (such as when pressing F5), use has_feature with the "editor" argument instead. OS.has_feature("editor") evaluate to true both when the script is running in the editor and when running the project from the editor, but returns false when run from an exported project.

pub fn is_embedded_in_editor(&self) -> bool

Returns true if the engine is running embedded in the editor. This is useful to prevent attempting to update window mode or window flags that are not supported when running the project embedded in the editor.

pub fn get_write_movie_path(&self) -> GString

Returns the path to the MovieWriter’s output file, or an empty string if the engine wasn’t started in Movie Maker mode. The default path can be changed in [member ProjectSettings.editor/movie_writer/movie_file].

pub fn set_print_to_stdout(&mut self, enabled: bool)

pub fn is_printing_to_stdout(&self) -> bool

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_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error

pub fn get_class(&self) -> GString

Returns the object’s built-in class name, as a String. See also is_class.

Note: This method ignores class_name declarations. If this object’s script has defined a class_name, the base, built-in class name is returned instead.

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

Returns true if the object inherits from the given class. See also get_class.

var sprite2d = Sprite2D.new()
sprite2d.is_class("Sprite2D") # Returns true
sprite2d.is_class("Node")     # Returns true
sprite2d.is_class("Node3D")   # Returns false

Note: This method ignores class_name declarations in the object’s script.

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

Assigns value to the given property. If the property does not exist or the given value’s type doesn’t match, nothing happens.

var node = Node2D.new()
node.set("global_scale", Vector2(8, 2.5))
print(node.global_scale) # Prints (8.0, 2.5)

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

Returns the Variant value of the given property. If the property does not exist, this method returns null.

var node = Node2D.new()
node.rotation = 1.5
var a = node.get("rotation") # a is 1.5

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

Assigns a new value to the property identified by the property_path. The path should be a NodePath relative to this object, and can use the colon character (:) to access nested properties.

var node = Node2D.new()
node.set_indexed("position", Vector2(42, 0))
node.set_indexed("position:y", -10)
print(node.position) # Prints (42.0, -10.0)

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

Gets the object’s property indexed by the given property_path. The path should be a NodePath relative to the current object and can use the colon character (:) to access nested properties.

Examples: "position:x" or "material:next_pass:blend_mode".

var node = Node2D.new()
node.position = Vector2(5, -10)
var a = node.get_indexed("position")   # a is Vector2(5, -10)
var b = node.get_indexed("position:y") # b is -10

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

Note: This method does not support actual paths to nodes in the SceneTree, only sub-property paths. In the context of nodes, use get_node_and_resource instead.

pub fn get_property_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns the object’s property list as an Array of dictionaries. Each Dictionary contains the following entries:

name is the property’s name, as a String;
class_name is an empty StringName, unless the property is VariantType::OBJECT and it inherits from a class;
type is the property’s type, as an int (see [enum Variant.Type]);
hint is how the property is meant to be edited (see [enum PropertyHint]);
hint_string depends on the hint (see [enum PropertyHint]);
usage is a combination of [enum PropertyUsageFlags].

Note: In GDScript, all class members are treated as properties. In C# and GDExtension, it may be necessary to explicitly mark class members as Godot properties using decorators or attributes.

pub fn get_method_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns this object’s methods and their signatures as an Array of dictionaries. Each Dictionary contains the following entries:

name is the name of the method, as a String;
args is an Array of dictionaries representing the arguments;
default_args is the default arguments as an Array of variants;
flags is a combination of [enum MethodFlags];
id is the method’s internal identifier int;
return is the returned value, as a Dictionary;

Note: The dictionaries of args and return are formatted identically to the results of get_property_list, although not all entries are used.

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

Returns true if the given property has a custom default value. Use property_get_revert to get the property’s default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_can_revert] to customize the default value. If [method _property_can_revert] is not implemented, this method returns false.

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

Returns the custom default value of the given property. Use property_can_revert to check if the property has a custom default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_get_revert] to customize the default value. If [method _property_get_revert] is not implemented, this method returns null.

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

Adds or changes the entry name inside the object’s metadata. The metadata value can be any Variant, although some types cannot be serialized correctly.

If value is null, the entry is removed. This is the equivalent of using remove_meta. See also has_meta and get_meta.