mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
273 lines
11 KiB
ReStructuredText
273 lines
11 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the Engine.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_Engine:
|
|
|
|
Engine
|
|
======
|
|
|
|
**Inherits:** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Access to basic engine properties.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`editor_hint<class_Engine_property_editor_hint>` |
|
|
+---------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`iterations_per_second<class_Engine_property_iterations_per_second>` |
|
|
+---------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`physics_jitter_fix<class_Engine_property_physics_jitter_fix>` |
|
|
+---------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`target_fps<class_Engine_property_target_fps>` |
|
|
+---------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`time_scale<class_Engine_property_time_scale>` |
|
|
+---------------------------+---------------------------------------------------------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_author_info<class_Engine_method_get_author_info>` **(** **)** const |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Array<class_Array>` | :ref:`get_copyright_info<class_Engine_method_get_copyright_info>` **(** **)** const |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_donor_info<class_Engine_method_get_donor_info>` **(** **)** const |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_frames_drawn<class_Engine_method_get_frames_drawn>` **(** **)** |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_frames_per_second<class_Engine_method_get_frames_per_second>` **(** **)** const |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_license_info<class_Engine_method_get_license_info>` **(** **)** const |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`get_license_text<class_Engine_method_get_license_text>` **(** **)** const |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`MainLoop<class_MainLoop>` | :ref:`get_main_loop<class_Engine_method_get_main_loop>` **(** **)** const |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Object<class_Object>` | :ref:`get_singleton<class_Engine_method_get_singleton>` **(** :ref:`String<class_String>` name **)** const |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_version_info<class_Engine_method_get_version_info>` **(** **)** const |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`has_singleton<class_Engine_method_has_singleton>` **(** :ref:`String<class_String>` name **)** const |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_in_physics_frame<class_Engine_method_is_in_physics_frame>` **(** **)** const |
|
|
+-------------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
The ``Engine`` class allows you to query and modify the game's run-time parameters, such as frames per second, time scale, and others.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_Engine_property_editor_hint:
|
|
|
|
- :ref:`bool<class_bool>` **editor_hint**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_editor_hint(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | is_editor_hint() |
|
|
+----------+------------------------+
|
|
|
|
If ``true``, it is running inside the editor. Useful for tool scripts.
|
|
|
|
----
|
|
|
|
.. _class_Engine_property_iterations_per_second:
|
|
|
|
- :ref:`int<class_int>` **iterations_per_second**
|
|
|
|
+----------+----------------------------------+
|
|
| *Setter* | set_iterations_per_second(value) |
|
|
+----------+----------------------------------+
|
|
| *Getter* | get_iterations_per_second() |
|
|
+----------+----------------------------------+
|
|
|
|
The number of fixed iterations per second (for fixed process and physics).
|
|
|
|
----
|
|
|
|
.. _class_Engine_property_physics_jitter_fix:
|
|
|
|
- :ref:`float<class_float>` **physics_jitter_fix**
|
|
|
|
+----------+-------------------------------+
|
|
| *Setter* | set_physics_jitter_fix(value) |
|
|
+----------+-------------------------------+
|
|
| *Getter* | get_physics_jitter_fix() |
|
|
+----------+-------------------------------+
|
|
|
|
----
|
|
|
|
.. _class_Engine_property_target_fps:
|
|
|
|
- :ref:`int<class_int>` **target_fps**
|
|
|
|
+----------+-----------------------+
|
|
| *Setter* | set_target_fps(value) |
|
|
+----------+-----------------------+
|
|
| *Getter* | get_target_fps() |
|
|
+----------+-----------------------+
|
|
|
|
The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit.
|
|
|
|
----
|
|
|
|
.. _class_Engine_property_time_scale:
|
|
|
|
- :ref:`float<class_float>` **time_scale**
|
|
|
|
+----------+-----------------------+
|
|
| *Setter* | set_time_scale(value) |
|
|
+----------+-----------------------+
|
|
| *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.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_Engine_method_get_author_info:
|
|
|
|
- :ref:`Dictionary<class_Dictionary>` **get_author_info** **(** **)** const
|
|
|
|
Returns engine author information in a Dictionary.
|
|
|
|
"lead_developers" - Array of Strings, lead developer names
|
|
|
|
"founders" - Array of Strings, founder names
|
|
|
|
"project_managers" - Array of Strings, project manager names
|
|
|
|
"developers" - Array of Strings, developer names
|
|
|
|
----
|
|
|
|
.. _class_Engine_method_get_copyright_info:
|
|
|
|
- :ref:`Array<class_Array>` **get_copyright_info** **(** **)** const
|
|
|
|
Returns an Array of copyright information Dictionaries.
|
|
|
|
"name" - String, component name
|
|
|
|
"parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component
|
|
|
|
----
|
|
|
|
.. _class_Engine_method_get_donor_info:
|
|
|
|
- :ref:`Dictionary<class_Dictionary>` **get_donor_info** **(** **)** const
|
|
|
|
Returns a Dictionary of Arrays of donor names.
|
|
|
|
{"platinum_sponsors", "gold_sponsors", "mini_sponsors", "gold_donors", "silver_donors", "bronze_donors"}
|
|
|
|
----
|
|
|
|
.. _class_Engine_method_get_frames_drawn:
|
|
|
|
- :ref:`int<class_int>` **get_frames_drawn** **(** **)**
|
|
|
|
Returns the total number of frames drawn.
|
|
|
|
----
|
|
|
|
.. _class_Engine_method_get_frames_per_second:
|
|
|
|
- :ref:`float<class_float>` **get_frames_per_second** **(** **)** const
|
|
|
|
Returns the frames per second of the running game.
|
|
|
|
----
|
|
|
|
.. _class_Engine_method_get_license_info:
|
|
|
|
- :ref:`Dictionary<class_Dictionary>` **get_license_info** **(** **)** const
|
|
|
|
Returns Dictionary of licenses used by Godot and included third party components.
|
|
|
|
----
|
|
|
|
.. _class_Engine_method_get_license_text:
|
|
|
|
- :ref:`String<class_String>` **get_license_text** **(** **)** const
|
|
|
|
Returns Godot license text.
|
|
|
|
----
|
|
|
|
.. _class_Engine_method_get_main_loop:
|
|
|
|
- :ref:`MainLoop<class_MainLoop>` **get_main_loop** **(** **)** const
|
|
|
|
Returns the main loop object (see :ref:`MainLoop<class_MainLoop>` and :ref:`SceneTree<class_SceneTree>`).
|
|
|
|
----
|
|
|
|
.. _class_Engine_method_get_singleton:
|
|
|
|
- :ref:`Object<class_Object>` **get_singleton** **(** :ref:`String<class_String>` name **)** const
|
|
|
|
----
|
|
|
|
.. _class_Engine_method_get_version_info:
|
|
|
|
- :ref:`Dictionary<class_Dictionary>` **get_version_info** **(** **)** const
|
|
|
|
Returns the current engine version information in a Dictionary.
|
|
|
|
``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
|
|
|
|
``hex`` - Holds the full version number encoded as an hexadecimal int with one byte (2 places) per number (see example below)
|
|
|
|
``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
|
|
|
|
``hash`` - Holds the full Git commit hash as a String
|
|
|
|
``year`` - Holds the year the version was released in as an int
|
|
|
|
``string`` - ``major`` + ``minor`` + ``patch`` + ``status`` + ``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 that it's still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for easy version comparisons from code:
|
|
|
|
::
|
|
|
|
if Engine.get_version_info().hex >= 0x030200:
|
|
# do things specific to version 3.2 or later
|
|
else:
|
|
# do things specific to versions before 3.2
|
|
|
|
----
|
|
|
|
.. _class_Engine_method_has_singleton:
|
|
|
|
- :ref:`bool<class_bool>` **has_singleton** **(** :ref:`String<class_String>` name **)** const
|
|
|
|
----
|
|
|
|
.. _class_Engine_method_is_in_physics_frame:
|
|
|
|
- :ref:`bool<class_bool>` **is_in_physics_frame** **(** **)** const
|
|
|
|
Returns ``true`` if the game is inside the fixed process and physics phase of the game loop.
|
|
|