classref: Sync with current master branch

2026-01-05 22:09:56 +03:00 · 2017-04-07 22:11:07 +02:00
parent 447b439db5
commit c282b77a58
392 changed files with 14087 additions and 12472 deletions
--- a/classes/class_engine.rst
+++ b/classes/class_engine.rst
@@ -0,0 +1,120 @@
+.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
+.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
+
+.. _class_Engine:
+
+Engine
+======
+
+**Inherits:** :ref:`Object<class_object>`
+
+**Category:** Core
+
+Brief Description
+-----------------
+
+
+
+Member Functions
+----------------
+
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`String<class_string>`          | :ref:`get_custom_level<class_Engine_get_custom_level>`  **(** **)** const                                                          |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`int<class_int>`                | :ref:`get_frames_drawn<class_Engine_get_frames_drawn>`  **(** **)**                                                                |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`float<class_float>`            | :ref:`get_frames_per_second<class_Engine_get_frames_per_second>`  **(** **)** const                                                |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`int<class_int>`                | :ref:`get_iterations_per_second<class_Engine_get_iterations_per_second>`  **(** **)** const                                        |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`MainLoop<class_mainloop>`      | :ref:`get_main_loop<class_Engine_get_main_loop>`  **(** **)** const                                                                |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`float<class_float>`            | :ref:`get_target_fps<class_Engine_get_target_fps>`  **(** **)** const                                                              |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`float<class_float>`            | :ref:`get_time_scale<class_Engine_get_time_scale>`  **(** **)**                                                                    |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`Dictionary<class_dictionary>`  | :ref:`get_version_info<class_Engine_get_version_info>`  **(** **)** const                                                          |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+| void                                 | :ref:`set_iterations_per_second<class_Engine_set_iterations_per_second>`  **(** :ref:`int<class_int>` iterations_per_second  **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+| void                                 | :ref:`set_target_fps<class_Engine_set_target_fps>`  **(** :ref:`int<class_int>` target_fps  **)**                                  |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+| void                                 | :ref:`set_time_scale<class_Engine_set_time_scale>`  **(** :ref:`float<class_float>` time_scale  **)**                              |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
+
+Member Function Description
+---------------------------
+
+.. _class_Engine_get_custom_level:
+
+- :ref:`String<class_string>`  **get_custom_level**  **(** **)** const
+
+Returns the value of the commandline argument "-level".
+
+.. _class_Engine_get_frames_drawn:
+
+- :ref:`int<class_int>`  **get_frames_drawn**  **(** **)**
+
+Return the total amount of frames drawn.
+
+.. _class_Engine_get_frames_per_second:
+
+- :ref:`float<class_float>`  **get_frames_per_second**  **(** **)** const
+
+Returns the frames per second of the running game.
+
+.. _class_Engine_get_iterations_per_second:
+
+- :ref:`int<class_int>`  **get_iterations_per_second**  **(** **)** const
+
+Return the amount of fixed iterations per second (for fixed process and physics).
+
+.. _class_Engine_get_main_loop:
+
+- :ref:`MainLoop<class_mainloop>`  **get_main_loop**  **(** **)** const
+
+Return the main loop object (see :ref:`MainLoop<class_mainloop>` and :ref:`SceneTree<class_scenetree>`).
+
+.. _class_Engine_get_target_fps:
+
+- :ref:`float<class_float>`  **get_target_fps**  **(** **)** const
+
+.. _class_Engine_get_time_scale:
+
+- :ref:`float<class_float>`  **get_time_scale**  **(** **)**
+
+.. _class_Engine_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 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
+
+"revision" - Holds the revision (e.g. "custom-build") as a String
+
+"string"   - major + minor + patch + status + revision in a single String
+
+.. _class_Engine_set_iterations_per_second:
+
+- void  **set_iterations_per_second**  **(** :ref:`int<class_int>` iterations_per_second  **)**
+
+Set the amount of fixed iterations per second (for fixed process and physics).
+
+.. _class_Engine_set_target_fps:
+
+- void  **set_target_fps**  **(** :ref:`int<class_int>` target_fps  **)**
+
+.. _class_Engine_set_time_scale:
+
+- void  **set_time_scale**  **(** :ref:`float<class_float>` time_scale  **)**
+
+