2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-06-14 17:37:51 +02:00
<class name= "Engine" inherits= "Object" category= "Core" version= "3.0.4" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-10-08 16:22:02 +02:00
Access to basic engine properties.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2017-10-22 12:56:11 +02:00
The [code]Engine[/code] class allows you to query and modify the game's run-time parameters, such as frames per second, time scale, and others.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "get_frames_drawn" >
<return type= "int" >
</return>
<description >
2017-10-08 16:22:02 +02:00
Returns the total number of frames drawn.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_frames_per_second" qualifiers= "const" >
<return type= "float" >
</return>
<description >
Returns the frames per second of the running game.
</description>
</method>
<method name= "get_main_loop" qualifiers= "const" >
<return type= "MainLoop" >
</return>
<description >
2017-10-08 16:22:02 +02:00
Returns the main loop object (see [MainLoop] and [SceneTree]).
2017-09-12 22:42:36 +02:00
</description>
</method>
2017-11-15 20:35:18 +01:00
<method name= "get_singleton" qualifiers= "const" >
<return type= "Object" >
</return>
<argument index= "0" name= "name" type= "String" >
</argument>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "get_version_info" qualifiers= "const" >
<return type= "Dictionary" >
</return>
<description >
Returns the current engine version information in a Dictionary.
2018-05-04 16:27:58 +02:00
"major" - Holds the major version number as an int
"minor" - Holds the minor version number as an int
"patch" - Holds the patch version number as an int
2017-09-12 22:42:36 +02:00
"status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String
2017-11-19 21:26:05 +01:00
"build" - Holds the build name (e.g. "custom-build") as a String
"string" - major + minor + patch + status + build in a single String
2017-09-12 22:42:36 +02:00
</description>
</method>
2017-11-15 20:35:18 +01:00
<method name= "has_singleton" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "name" type= "String" >
</argument>
<description >
</description>
</method>
2017-10-08 16:22:02 +02:00
<method name= "is_in_physics_frame" qualifiers= "const" >
2017-09-12 22:42:36 +02:00
<return type= "bool" >
</return>
<description >
2017-10-08 16:22:02 +02:00
Returns [code]true[/code] if the game is inside the fixed process and physics phase of the game loop.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
2018-01-11 23:38:35 +01:00
<members >
<member name= "editor_hint" type= "bool" setter= "set_editor_hint" getter= "is_editor_hint" >
If [code]true[/code], it is running inside the editor. Useful for tool scripts.
</member>
<member name= "iterations_per_second" type= "int" setter= "set_iterations_per_second" getter= "get_iterations_per_second" >
The number of fixed iterations per second (for fixed process and physics).
</member>
2018-01-13 11:43:30 +01:00
<member name= "target_fps" type= "int" setter= "set_target_fps" getter= "get_target_fps" >
2018-01-11 23:38:35 +01:00
The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit.
</member>
<member name= "time_scale" type= "float" setter= "set_time_scale" getter= "get_time_scale" >
Controls 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.
</member>
</members>
2017-09-12 22:42:36 +02:00
<constants >
</constants>
</class>