godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (2e7fc81)

Browse Source
This commit is contained in:
Godot Organization
2024-02-24 03:20:02 +00:00
parent 4f21f44632
commit 8978497bb6
938 changed files with 42729 additions and 36889 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
classes/class_editorpaths.rst
View File

@@ -40,19 +40,19 @@ Methods
.. table::
:widths: auto
+-----------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_cache_dir<class_EditorPaths_method_get_cache_dir>` **(** **)** |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_config_dir<class_EditorPaths_method_get_config_dir>` **(** **)** |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_data_dir<class_EditorPaths_method_get_data_dir>` **(** **)** |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_project_settings_dir<class_EditorPaths_method_get_project_settings_dir>` **(** **)** |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_self_contained_file<class_EditorPaths_method_get_self_contained_file>` **(** **)** |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_self_contained<class_EditorPaths_method_is_self_contained>` **(** **)** |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------------+
+-----------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_cache_dir<class_EditorPaths_method_get_cache_dir>`\ (\ ) |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_config_dir<class_EditorPaths_method_get_config_dir>`\ (\ ) |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_data_dir<class_EditorPaths_method_get_data_dir>`\ (\ ) |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_project_settings_dir<class_EditorPaths_method_get_project_settings_dir>`\ (\ ) |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_self_contained_file<class_EditorPaths_method_get_self_contained_file>`\ (\ ) |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_self_contained<class_EditorPaths_method_is_self_contained>`\ (\ ) |const| |
+-----------------------------+--------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@@ -67,7 +67,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`String<class_String>` **get_cache_dir** **(** **)** |const|
:ref:`String<class_String>` **get_cache_dir**\ (\ ) |const|
Returns the absolute path to the user's cache folder. This folder should be used for temporary data that can be removed safely whenever the editor is closed (such as generated resource thumbnails).
@@ -87,7 +87,7 @@ Returns the absolute path to the user's cache folder. This folder should be used
.. rst-class:: classref-method
:ref:`String<class_String>` **get_config_dir** **(** **)** |const|
:ref:`String<class_String>` **get_config_dir**\ (\ ) |const|
Returns the absolute path to the user's configuration folder. This folder should be used for *persistent* user configuration files.
@@ -107,7 +107,7 @@ Returns the absolute path to the user's configuration folder. This folder should
.. rst-class:: classref-method
:ref:`String<class_String>` **get_data_dir** **(** **)** |const|
:ref:`String<class_String>` **get_data_dir**\ (\ ) |const|
Returns the absolute path to the user's data folder. This folder should be used for *persistent* user data files such as installed export templates.
@@ -127,7 +127,7 @@ Returns the absolute path to the user's data folder. This folder should be used
.. rst-class:: classref-method
:ref:`String<class_String>` **get_project_settings_dir** **(** **)** |const|
:ref:`String<class_String>` **get_project_settings_dir**\ (\ ) |const|
Returns the project-specific editor settings path. Projects all have a unique subdirectory inside the settings path where project-specific editor settings are saved.
@@ -139,7 +139,7 @@ Returns the project-specific editor settings path. Projects all have a unique su
.. rst-class:: classref-method
:ref:`String<class_String>` **get_self_contained_file** **(** **)** |const|
:ref:`String<class_String>` **get_self_contained_file**\ (\ ) |const|
Returns the absolute path to the self-contained file that makes the current Godot editor instance be considered as self-contained. Returns an empty string if the current Godot editor instance isn't self-contained. See also :ref:`is_self_contained<class_EditorPaths_method_is_self_contained>`.
@@ -151,7 +151,7 @@ Returns the absolute path to the self-contained file that makes the current Godo
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_self_contained** **(** **)** |const|
:ref:`bool<class_bool>` **is_self_contained**\ (\ ) |const|
Returns ``true`` if the editor is marked as self-contained, ``false`` otherwise. When self-contained mode is enabled, user configuration, data and cache files are saved in an ``editor_data/`` folder next to the editor binary. This makes portable usage easier and ensures the Godot editor minimizes file writes outside its own folder. Self-contained mode is not available for exported projects.
@@ -170,3 +170,4 @@ Self-contained mode can be enabled by creating a file named ``._sc_`` or ``_sc_`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`