mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 18:29:11 +00:00
classref: Sync with current master branch (705b7a0)
This commit is contained in:
Godot Organization
+31
-31
@@ -116,7 +116,7 @@ Property Descriptions
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`int<class_int>` **max_fps** = ``0``
|
||||
:ref:`int<class_int>` **max_fps** = ``0`` :ref:`🔗<class_Engine_property_max_fps>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -145,7 +145,7 @@ See also :ref:`physics_ticks_per_second<class_Engine_property_physics_ticks_per_
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`int<class_int>` **max_physics_steps_per_frame** = ``8``
|
||||
:ref:`int<class_int>` **max_physics_steps_per_frame** = ``8`` :ref:`🔗<class_Engine_property_max_physics_steps_per_frame>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -164,7 +164,7 @@ The maximum number of physics steps that can be simulated each rendered frame.
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`float<class_float>` **physics_jitter_fix** = ``0.5``
|
||||
:ref:`float<class_float>` **physics_jitter_fix** = ``0.5`` :ref:`🔗<class_Engine_property_physics_jitter_fix>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -185,7 +185,7 @@ How much physics ticks are synchronized with real time. If ``0`` or less, the ti
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`int<class_int>` **physics_ticks_per_second** = ``60``
|
||||
:ref:`int<class_int>` **physics_ticks_per_second** = ``60`` :ref:`🔗<class_Engine_property_physics_ticks_per_second>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -204,7 +204,7 @@ The number of fixed iterations per second. This controls how often physics simul
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`bool<class_bool>` **print_error_messages** = ``true``
|
||||
:ref:`bool<class_bool>` **print_error_messages** = ``true`` :ref:`🔗<class_Engine_property_print_error_messages>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -225,7 +225,7 @@ If ``false``, stops printing error and warning messages to the console and edito
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`float<class_float>` **time_scale** = ``1.0``
|
||||
:ref:`float<class_float>` **time_scale** = ``1.0`` :ref:`🔗<class_Engine_property_time_scale>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -255,7 +255,7 @@ Method Descriptions
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`String<class_String>` **get_architecture_name**\ (\ ) |const|
|
||||
:ref:`String<class_String>` **get_architecture_name**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_architecture_name>`
|
||||
|
||||
Returns the name of the CPU architecture the Godot binary was built for. Possible return values include ``"x86_64"``, ``"x86_32"``, ``"arm64"``, ``"arm32"``, ``"rv64"``, ``"riscv"``, ``"ppc64"``, ``"ppc"``, ``"wasm64"``, and ``"wasm32"``.
|
||||
|
||||
@@ -290,7 +290,7 @@ To detect whether the current build is 64-bit, you can use the fact that all 64-
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Dictionary<class_Dictionary>` **get_author_info**\ (\ ) |const|
|
||||
:ref:`Dictionary<class_Dictionary>` **get_author_info**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_author_info>`
|
||||
|
||||
Returns the engine author information as a :ref:`Dictionary<class_Dictionary>`, where each entry is an :ref:`Array<class_Array>` of strings with the names of notable contributors to the Godot Engine: ``lead_developers``, ``founders``, ``project_managers``, and ``developers``.
|
||||
|
||||
@@ -302,7 +302,7 @@ Returns the engine author information as a :ref:`Dictionary<class_Dictionary>`,
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_copyright_info**\ (\ ) |const|
|
||||
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_copyright_info**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_copyright_info>`
|
||||
|
||||
Returns an :ref:`Array<class_Array>` of dictionaries with copyright information for every component of Godot's source code.
|
||||
|
||||
@@ -322,7 +322,7 @@ Every :ref:`Dictionary<class_Dictionary>` contains a ``name`` identifier, and a
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Dictionary<class_Dictionary>` **get_donor_info**\ (\ ) |const|
|
||||
:ref:`Dictionary<class_Dictionary>` **get_donor_info**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_donor_info>`
|
||||
|
||||
Returns a :ref:`Dictionary<class_Dictionary>` of categorized donor names. Each entry is an :ref:`Array<class_Array>` of strings:
|
||||
|
||||
@@ -336,7 +336,7 @@ Returns a :ref:`Dictionary<class_Dictionary>` of categorized donor names. Each e
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **get_frames_drawn**\ (\ )
|
||||
:ref:`int<class_int>` **get_frames_drawn**\ (\ ) :ref:`🔗<class_Engine_method_get_frames_drawn>`
|
||||
|
||||
Returns the total number of frames drawn since the engine started.
|
||||
|
||||
@@ -350,7 +350,7 @@ Returns the total number of frames drawn since the engine started.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`float<class_float>` **get_frames_per_second**\ (\ ) |const|
|
||||
:ref:`float<class_float>` **get_frames_per_second**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_frames_per_second>`
|
||||
|
||||
Returns the average frames rendered every second (FPS), also known as the framerate.
|
||||
|
||||
@@ -362,7 +362,7 @@ Returns the average frames rendered every second (FPS), also known as the framer
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Dictionary<class_Dictionary>` **get_license_info**\ (\ ) |const|
|
||||
:ref:`Dictionary<class_Dictionary>` **get_license_info**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_license_info>`
|
||||
|
||||
Returns a :ref:`Dictionary<class_Dictionary>` of licenses used by Godot and included third party components. Each entry is a license name (such as "`Expat <https://en.wikipedia.org/wiki/MIT_License#Ambiguity_and_variants>`__") and its associated text.
|
||||
|
||||
@@ -374,7 +374,7 @@ Returns a :ref:`Dictionary<class_Dictionary>` of licenses used by Godot and incl
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`String<class_String>` **get_license_text**\ (\ ) |const|
|
||||
:ref:`String<class_String>` **get_license_text**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_license_text>`
|
||||
|
||||
Returns the full Godot license text.
|
||||
|
||||
@@ -386,7 +386,7 @@ Returns the full Godot license text.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`MainLoop<class_MainLoop>` **get_main_loop**\ (\ ) |const|
|
||||
:ref:`MainLoop<class_MainLoop>` **get_main_loop**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_main_loop>`
|
||||
|
||||
Returns the instance of the :ref:`MainLoop<class_MainLoop>`. This is usually the main :ref:`SceneTree<class_SceneTree>` and is the same as :ref:`Node.get_tree<class_Node_method_get_tree>`.
|
||||
|
||||
@@ -400,7 +400,7 @@ Returns the instance of the :ref:`MainLoop<class_MainLoop>`. This is usually the
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **get_physics_frames**\ (\ ) |const|
|
||||
:ref:`int<class_int>` **get_physics_frames**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_physics_frames>`
|
||||
|
||||
Returns the total number of frames passed since the engine started. This number is increased every **physics frame**. See also :ref:`get_process_frames<class_Engine_method_get_process_frames>`.
|
||||
|
||||
@@ -437,7 +437,7 @@ This method can be used to run expensive logic less often without relying on a :
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`float<class_float>` **get_physics_interpolation_fraction**\ (\ ) |const|
|
||||
:ref:`float<class_float>` **get_physics_interpolation_fraction**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_physics_interpolation_fraction>`
|
||||
|
||||
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.
|
||||
|
||||
@@ -449,7 +449,7 @@ Returns the fraction through the current physics tick we are at the time of rend
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **get_process_frames**\ (\ ) |const|
|
||||
:ref:`int<class_int>` **get_process_frames**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_process_frames>`
|
||||
|
||||
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 :ref:`get_frames_drawn<class_Engine_method_get_frames_drawn>` and :ref:`get_physics_frames<class_Engine_method_get_physics_frames>`.
|
||||
|
||||
@@ -486,7 +486,7 @@ This method can be used to run expensive logic less often without relying on a :
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`ScriptLanguage<class_ScriptLanguage>` **get_script_language**\ (\ index\: :ref:`int<class_int>`\ ) |const|
|
||||
:ref:`ScriptLanguage<class_ScriptLanguage>` **get_script_language**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_Engine_method_get_script_language>`
|
||||
|
||||
Returns an instance of a :ref:`ScriptLanguage<class_ScriptLanguage>` with the given ``index``.
|
||||
|
||||
@@ -498,7 +498,7 @@ Returns an instance of a :ref:`ScriptLanguage<class_ScriptLanguage>` with the gi
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **get_script_language_count**\ (\ )
|
||||
:ref:`int<class_int>` **get_script_language_count**\ (\ ) :ref:`🔗<class_Engine_method_get_script_language_count>`
|
||||
|
||||
Returns the number of available script languages. Use with :ref:`get_script_language<class_Engine_method_get_script_language>`.
|
||||
|
||||
@@ -510,7 +510,7 @@ Returns the number of available script languages. Use with :ref:`get_script_lang
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Object<class_Object>` **get_singleton**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const|
|
||||
:ref:`Object<class_Object>` **get_singleton**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_Engine_method_get_singleton>`
|
||||
|
||||
Returns the global singleton with the given ``name``, or ``null`` if it does not exist. Often used for plugins. See also :ref:`has_singleton<class_Engine_method_has_singleton>` and :ref:`get_singleton_list<class_Engine_method_get_singleton_list>`.
|
||||
|
||||
@@ -524,7 +524,7 @@ Returns the global singleton with the given ``name``, or ``null`` if it does not
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`PackedStringArray<class_PackedStringArray>` **get_singleton_list**\ (\ ) |const|
|
||||
:ref:`PackedStringArray<class_PackedStringArray>` **get_singleton_list**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_singleton_list>`
|
||||
|
||||
Returns a list of names of all available global singletons. See also :ref:`get_singleton<class_Engine_method_get_singleton>`.
|
||||
|
||||
@@ -536,7 +536,7 @@ Returns a list of names of all available global singletons. See also :ref:`get_s
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Dictionary<class_Dictionary>` **get_version_info**\ (\ ) |const|
|
||||
:ref:`Dictionary<class_Dictionary>` **get_version_info**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_version_info>`
|
||||
|
||||
Returns the current engine version information as a :ref:`Dictionary<class_Dictionary>` containing the following entries:
|
||||
|
||||
@@ -593,7 +593,7 @@ The ``hex`` value is encoded as follows, from left to right: one byte for the ma
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`String<class_String>` **get_write_movie_path**\ (\ ) |const|
|
||||
:ref:`String<class_String>` **get_write_movie_path**\ (\ ) |const| :ref:`🔗<class_Engine_method_get_write_movie_path>`
|
||||
|
||||
Returns the path to the :ref:`MovieWriter<class_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 :ref:`ProjectSettings.editor/movie_writer/movie_file<class_ProjectSettings_property_editor/movie_writer/movie_file>`.
|
||||
|
||||
@@ -605,7 +605,7 @@ Returns the path to the :ref:`MovieWriter<class_MovieWriter>`'s output file, or
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **has_singleton**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const|
|
||||
:ref:`bool<class_bool>` **has_singleton**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_Engine_method_has_singleton>`
|
||||
|
||||
Returns ``true`` if a singleton with the given ``name`` exists in the global scope. See also :ref:`get_singleton<class_Engine_method_get_singleton>`.
|
||||
|
||||
@@ -638,7 +638,7 @@ Returns ``true`` if a singleton with the given ``name`` exists in the global sco
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **is_editor_hint**\ (\ ) |const|
|
||||
:ref:`bool<class_bool>` **is_editor_hint**\ (\ ) |const| :ref:`🔗<class_Engine_method_is_editor_hint>`
|
||||
|
||||
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:
|
||||
|
||||
@@ -673,7 +673,7 @@ See :doc:`Running code in the editor <../tutorials/plugins/running_code_in_the_e
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **is_in_physics_frame**\ (\ ) |const|
|
||||
:ref:`bool<class_bool>` **is_in_physics_frame**\ (\ ) |const| :ref:`🔗<class_Engine_method_is_in_physics_frame>`
|
||||
|
||||
Returns ``true`` if the engine is inside the fixed physics process step of the main loop.
|
||||
|
||||
@@ -698,7 +698,7 @@ Returns ``true`` if the engine is inside the fixed physics process step of the m
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Error<enum_@GlobalScope_Error>` **register_script_language**\ (\ language\: :ref:`ScriptLanguage<class_ScriptLanguage>`\ )
|
||||
:ref:`Error<enum_@GlobalScope_Error>` **register_script_language**\ (\ language\: :ref:`ScriptLanguage<class_ScriptLanguage>`\ ) :ref:`🔗<class_Engine_method_register_script_language>`
|
||||
|
||||
Registers a :ref:`ScriptLanguage<class_ScriptLanguage>` instance to be available with ``ScriptServer``.
|
||||
|
||||
@@ -718,7 +718,7 @@ Returns:
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **register_singleton**\ (\ name\: :ref:`StringName<class_StringName>`, instance\: :ref:`Object<class_Object>`\ )
|
||||
|void| **register_singleton**\ (\ name\: :ref:`StringName<class_StringName>`, instance\: :ref:`Object<class_Object>`\ ) :ref:`🔗<class_Engine_method_register_singleton>`
|
||||
|
||||
Registers the given :ref:`Object<class_Object>` ``instance`` as a singleton, available globally under ``name``. Useful for plugins.
|
||||
|
||||
@@ -730,7 +730,7 @@ Registers the given :ref:`Object<class_Object>` ``instance`` as a singleton, ava
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Error<enum_@GlobalScope_Error>` **unregister_script_language**\ (\ language\: :ref:`ScriptLanguage<class_ScriptLanguage>`\ )
|
||||
:ref:`Error<enum_@GlobalScope_Error>` **unregister_script_language**\ (\ language\: :ref:`ScriptLanguage<class_ScriptLanguage>`\ ) :ref:`🔗<class_Engine_method_unregister_script_language>`
|
||||
|
||||
Unregisters the :ref:`ScriptLanguage<class_ScriptLanguage>` instance from ``ScriptServer``.
|
||||
|
||||
@@ -748,7 +748,7 @@ Returns:
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **unregister_singleton**\ (\ name\: :ref:`StringName<class_StringName>`\ )
|
||||
|void| **unregister_singleton**\ (\ name\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_Engine_method_unregister_singleton>`
|
||||
|
||||
Removes the singleton registered under ``name``. The singleton object is *not* freed. Only works with user-defined singletons registered with :ref:`register_singleton<class_Engine_method_register_singleton>`.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user