Inherits: Object

Category: Core

Brief Description

Access to basic engine properties.

Member Functions

int get_frames_drawn ( )
float get_frames_per_second ( ) const
int get_iterations_per_second ( ) const
MainLoop get_main_loop ( ) const
Object get_singleton ( String name ) const
float get_target_fps ( ) const
float get_time_scale ( )
Dictionary get_version_info ( ) const
bool has_singleton ( String name ) const
bool is_editor_hint ( ) const
bool is_in_physics_frame ( ) const
void set_editor_hint ( bool enabled )
void set_iterations_per_second ( int iterations_per_second )
void set_target_fps ( int target_fps )
void set_time_scale ( float time_scale )


The Engine class allows you to query and modify the game’s run-time parameters, such as frames per second, time scale, and others.

Member Function Description

  • int get_frames_drawn ( )

Returns the total number of frames drawn.

  • float get_frames_per_second ( ) const

Returns the frames per second of the running game.

  • int get_iterations_per_second ( ) const

Returns the number of fixed iterations per second (for fixed process and physics).

Returns the main loop object (see MainLoop and SceneTree).

  • float get_target_fps ( ) const

Returns the desired frames per second. If the hardware cannot keep up, this setting may not be respected. It defaults to 0, which indicates no limit.

  • float get_time_scale ( )

Returns how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed.

Returns the current engine version information in a Dictionary.

“major” - Holds the major version number as a String

“minor” - Holds the minor version number as a String

“patch” - Holds the patch version number as a String

“status” - Holds the status (e.g. “beta”, “rc1”, “rc2”, ... “stable”) as a String

“build” - Holds the build name (e.g. “custom-build”) as a String

“string” - major + minor + patch + status + build in a single String

  • bool is_editor_hint ( ) const

Returns true if the editor is running.

  • bool is_in_physics_frame ( ) const

Returns true if the game is inside the fixed process and physics phase of the game loop.

  • void set_editor_hint ( bool enabled )

Sets the running inside the editor hint if enabled is true.

  • void set_iterations_per_second ( int iterations_per_second )

Sets the number of fixed iterations per second (for fixed process and physics).

  • void set_target_fps ( int target_fps )

Sets the target frames per second.

  • void set_time_scale ( float time_scale )

Sets the time scale.