stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (705b7a0)

Browse Source
This commit is contained in:
Godot Organization
2024-05-31 13:54:35 +00:00
parent 32f1b6ea48
commit eacfba2716
835 changed files with 17350 additions and 17256 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_editorexportplugin.rst
+36 -36
View File
@@ -123,7 +123,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_begin_customize_resources**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, features\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |virtual| |const|
:ref:`bool<class_bool>` **_begin_customize_resources**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, features\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__begin_customize_resources>`
Return ``true`` if this plugin will customize resources based on the platform and features used.
@@ -137,7 +137,7 @@ When enabled, :ref:`_get_customization_configuration_hash<class_EditorExportPlug
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_begin_customize_scenes**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, features\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |virtual| |const|
:ref:`bool<class_bool>` **_begin_customize_scenes**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, features\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__begin_customize_scenes>`
Return true if this plugin will customize scenes based on the platform and features used.
@@ -149,7 +149,7 @@ Return true if this plugin will customize scenes based on the platform and featu
.. rst-class:: classref-method
:ref:`Resource<class_Resource>` **_customize_resource**\ (\ resource\: :ref:`Resource<class_Resource>`, path\: :ref:`String<class_String>`\ ) |virtual|
:ref:`Resource<class_Resource>` **_customize_resource**\ (\ resource\: :ref:`Resource<class_Resource>`, path\: :ref:`String<class_String>`\ ) |virtual| :ref:`🔗<class_EditorExportPlugin_private_method__customize_resource>`
Customize a resource. If changes are made to it, return the same or a new resource. Otherwise, return ``null``.
@@ -165,7 +165,7 @@ Implementing this method is required if :ref:`_begin_customize_resources<class_E
.. rst-class:: classref-method
:ref:`Node<class_Node>` **_customize_scene**\ (\ scene\: :ref:`Node<class_Node>`, path\: :ref:`String<class_String>`\ ) |virtual|
:ref:`Node<class_Node>` **_customize_scene**\ (\ scene\: :ref:`Node<class_Node>`, path\: :ref:`String<class_String>`\ ) |virtual| :ref:`🔗<class_EditorExportPlugin_private_method__customize_scene>`
Customize a scene. If changes are made to it, return the same or a new scene. Otherwise, return ``null``. If a new scene is returned, it is up to you to dispose of the old one.
@@ -179,7 +179,7 @@ Implementing this method is required if :ref:`_begin_customize_scenes<class_Edit
.. rst-class:: classref-method
|void| **_end_customize_resources**\ (\ ) |virtual|
|void| **_end_customize_resources**\ (\ ) |virtual| :ref:`🔗<class_EditorExportPlugin_private_method__end_customize_resources>`
This is called when the customization process for resources ends.
@@ -191,7 +191,7 @@ This is called when the customization process for resources ends.
.. rst-class:: classref-method
|void| **_end_customize_scenes**\ (\ ) |virtual|
|void| **_end_customize_scenes**\ (\ ) |virtual| :ref:`🔗<class_EditorExportPlugin_private_method__end_customize_scenes>`
This is called when the customization process for scenes ends.
@@ -203,7 +203,7 @@ This is called when the customization process for scenes ends.
.. rst-class:: classref-method
|void| **_export_begin**\ (\ features\: :ref:`PackedStringArray<class_PackedStringArray>`, is_debug\: :ref:`bool<class_bool>`, path\: :ref:`String<class_String>`, flags\: :ref:`int<class_int>`\ ) |virtual|
|void| **_export_begin**\ (\ features\: :ref:`PackedStringArray<class_PackedStringArray>`, is_debug\: :ref:`bool<class_bool>`, path\: :ref:`String<class_String>`, flags\: :ref:`int<class_int>`\ ) |virtual| :ref:`🔗<class_EditorExportPlugin_private_method__export_begin>`
Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. ``features`` is the list of features for the export, ``is_debug`` is ``true`` for debug builds, ``path`` is the target path for the exported project. ``flags`` is only used when running a runnable profile, e.g. when using native run on Android.
@@ -215,7 +215,7 @@ Virtual method to be overridden by the user. It is called when the export starts
.. rst-class:: classref-method
|void| **_export_end**\ (\ ) |virtual|
|void| **_export_end**\ (\ ) |virtual| :ref:`🔗<class_EditorExportPlugin_private_method__export_end>`
Virtual method to be overridden by the user. Called when the export is finished.
@@ -227,7 +227,7 @@ Virtual method to be overridden by the user. Called when the export is finished.
.. rst-class:: classref-method
|void| **_export_file**\ (\ path\: :ref:`String<class_String>`, type\: :ref:`String<class_String>`, features\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |virtual|
|void| **_export_file**\ (\ path\: :ref:`String<class_String>`, type\: :ref:`String<class_String>`, features\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |virtual| :ref:`🔗<class_EditorExportPlugin_private_method__export_file>`
Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. ``path`` is the path of the file, ``type`` is the :ref:`Resource<class_Resource>` represented by the file (e.g. :ref:`PackedScene<class_PackedScene>`) and ``features`` is the list of features for the export.
@@ -241,7 +241,7 @@ Calling :ref:`skip<class_EditorExportPlugin_method_skip>` inside this callback w
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **_get_android_dependencies**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const|
:ref:`PackedStringArray<class_PackedStringArray>` **_get_android_dependencies**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_android_dependencies>`
Virtual method to be overridden by the user. This is called to retrieve the set of Android dependencies provided by this plugin. Each returned Android dependency should have the format of an Android remote binary dependency: ``org.godot.example:my-plugin:0.0.0``\
@@ -257,7 +257,7 @@ For more information see `Android documentation on dependencies <https://develop
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **_get_android_dependencies_maven_repos**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const|
:ref:`PackedStringArray<class_PackedStringArray>` **_get_android_dependencies_maven_repos**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_android_dependencies_maven_repos>`
Virtual method to be overridden by the user. This is called to retrieve the URLs of Maven repositories for the set of Android dependencies provided by this plugin.
@@ -275,7 +275,7 @@ For more information see `Gradle documentation on dependency management <https:/
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **_get_android_libraries**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const|
:ref:`PackedStringArray<class_PackedStringArray>` **_get_android_libraries**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_android_libraries>`
Virtual method to be overridden by the user. This is called to retrieve the local paths of the Android libraries archive (AAR) files provided by this plugin.
@@ -291,7 +291,7 @@ Virtual method to be overridden by the user. This is called to retrieve the loca
.. rst-class:: classref-method
:ref:`String<class_String>` **_get_android_manifest_activity_element_contents**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const|
:ref:`String<class_String>` **_get_android_manifest_activity_element_contents**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_android_manifest_activity_element_contents>`
Virtual method to be overridden by the user. This is used at export time to update the contents of the ``activity`` element in the generated Android manifest.
@@ -305,7 +305,7 @@ Virtual method to be overridden by the user. This is used at export time to upda
.. rst-class:: classref-method
:ref:`String<class_String>` **_get_android_manifest_application_element_contents**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const|
:ref:`String<class_String>` **_get_android_manifest_application_element_contents**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_android_manifest_application_element_contents>`
Virtual method to be overridden by the user. This is used at export time to update the contents of the ``application`` element in the generated Android manifest.
@@ -319,7 +319,7 @@ Virtual method to be overridden by the user. This is used at export time to upda
.. rst-class:: classref-method
:ref:`String<class_String>` **_get_android_manifest_element_contents**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const|
:ref:`String<class_String>` **_get_android_manifest_element_contents**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_android_manifest_element_contents>`
Virtual method to be overridden by the user. This is used at export time to update the contents of the ``manifest`` element in the generated Android manifest.
@@ -333,7 +333,7 @@ Virtual method to be overridden by the user. This is used at export time to upda
.. rst-class:: classref-method
:ref:`int<class_int>` **_get_customization_configuration_hash**\ (\ ) |virtual| |const|
:ref:`int<class_int>` **_get_customization_configuration_hash**\ (\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_customization_configuration_hash>`
Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations.
@@ -347,7 +347,7 @@ Implementing this method is required if :ref:`_begin_customize_resources<class_E
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **_get_export_features**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const|
:ref:`PackedStringArray<class_PackedStringArray>` **_get_export_features**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, debug\: :ref:`bool<class_bool>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_export_features>`
Return a :ref:`PackedStringArray<class_PackedStringArray>` of additional features this preset, for the given ``platform``, should have.
@@ -359,7 +359,7 @@ Return a :ref:`PackedStringArray<class_PackedStringArray>` of additional feature
.. rst-class:: classref-method
:ref:`String<class_String>` **_get_export_option_warning**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, option\: :ref:`String<class_String>`\ ) |virtual| |const|
:ref:`String<class_String>` **_get_export_option_warning**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, option\: :ref:`String<class_String>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_export_option_warning>`
Check the requirements for the given ``option`` and return a non-empty warning string if they are not met.
@@ -373,7 +373,7 @@ Check the requirements for the given ``option`` and return a non-empty warning s
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **_get_export_options**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`\ ) |virtual| |const|
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **_get_export_options**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_export_options>`
Return a list of export options that can be configured for this export plugin.
@@ -393,7 +393,7 @@ Each element in the return value is a :ref:`Dictionary<class_Dictionary>` with t
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **_get_export_options_overrides**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`\ ) |virtual| |const|
:ref:`Dictionary<class_Dictionary>` **_get_export_options_overrides**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_export_options_overrides>`
Return a :ref:`Dictionary<class_Dictionary>` of override values for export options, that will be used instead of user-provided values. Overridden options will be hidden from the user interface.
@@ -423,7 +423,7 @@ Return a :ref:`Dictionary<class_Dictionary>` of override values for export optio
.. rst-class:: classref-method
:ref:`String<class_String>` **_get_name**\ (\ ) |virtual| |const|
:ref:`String<class_String>` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__get_name>`
Return the name identifier of this plugin (for future identification by the exporter). The plugins are sorted by name before exporting.
@@ -437,7 +437,7 @@ Implementing this method is required.
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_should_update_export_options**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`\ ) |virtual| |const|
:ref:`bool<class_bool>` **_should_update_export_options**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__should_update_export_options>`
Return ``true``, if the result of :ref:`_get_export_options<class_EditorExportPlugin_private_method__get_export_options>` has changed and the export options of preset corresponding to ``platform`` should be updated.
@@ -449,7 +449,7 @@ Return ``true``, if the result of :ref:`_get_export_options<class_EditorExportPl
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_supports_platform**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`\ ) |virtual| |const|
:ref:`bool<class_bool>` **_supports_platform**\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlugin_private_method__supports_platform>`
Return ``true`` if the plugin supports the given ``platform``.
@@ -461,7 +461,7 @@ Return ``true`` if the plugin supports the given ``platform``.
.. rst-class:: classref-method
|void| **add_file**\ (\ path\: :ref:`String<class_String>`, file\: :ref:`PackedByteArray<class_PackedByteArray>`, remap\: :ref:`bool<class_bool>`\ )
|void| **add_file**\ (\ path\: :ref:`String<class_String>`, file\: :ref:`PackedByteArray<class_PackedByteArray>`, remap\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_file>`
Adds a custom file to be exported. ``path`` is the virtual path that can be used to load the file, ``file`` is the binary data of the file.
@@ -475,7 +475,7 @@ When called inside :ref:`_export_file<class_EditorExportPlugin_private_method__e
.. rst-class:: classref-method
|void| **add_ios_bundle_file**\ (\ path\: :ref:`String<class_String>`\ )
|void| **add_ios_bundle_file**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_bundle_file>`
Adds an iOS bundle file from the given ``path`` to the exported project.
@@ -487,7 +487,7 @@ Adds an iOS bundle file from the given ``path`` to the exported project.
.. rst-class:: classref-method
|void| **add_ios_cpp_code**\ (\ code\: :ref:`String<class_String>`\ )
|void| **add_ios_cpp_code**\ (\ code\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_cpp_code>`
Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin.
@@ -499,7 +499,7 @@ Adds a C++ code to the iOS export. The final code is created from the code appen
.. rst-class:: classref-method
|void| **add_ios_embedded_framework**\ (\ path\: :ref:`String<class_String>`\ )
|void| **add_ios_embedded_framework**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_embedded_framework>`
Adds a dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary.
@@ -515,7 +515,7 @@ Adds a dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode
.. rst-class:: classref-method
|void| **add_ios_framework**\ (\ path\: :ref:`String<class_String>`\ )
|void| **add_ios_framework**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_framework>`
Adds a static library (\*.a) or dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode project.
@@ -527,7 +527,7 @@ Adds a static library (\*.a) or dynamic library (\*.dylib, \*.framework) to Link
.. rst-class:: classref-method
|void| **add_ios_linker_flags**\ (\ flags\: :ref:`String<class_String>`\ )
|void| **add_ios_linker_flags**\ (\ flags\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_linker_flags>`
Adds linker flags for the iOS export.
@@ -539,7 +539,7 @@ Adds linker flags for the iOS export.
.. rst-class:: classref-method
|void| **add_ios_plist_content**\ (\ plist_content\: :ref:`String<class_String>`\ )
|void| **add_ios_plist_content**\ (\ plist_content\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_plist_content>`
Adds content for iOS Property List files.
@@ -551,7 +551,7 @@ Adds content for iOS Property List files.
.. rst-class:: classref-method
|void| **add_ios_project_static_lib**\ (\ path\: :ref:`String<class_String>`\ )
|void| **add_ios_project_static_lib**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_project_static_lib>`
Adds a static lib from the given ``path`` to the iOS project.
@@ -563,7 +563,7 @@ Adds a static lib from the given ``path`` to the iOS project.
.. rst-class:: classref-method
|void| **add_macos_plugin_file**\ (\ path\: :ref:`String<class_String>`\ )
|void| **add_macos_plugin_file**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_macos_plugin_file>`
Adds file or directory matching ``path`` to ``PlugIns`` directory of macOS app bundle.
@@ -577,7 +577,7 @@ Adds file or directory matching ``path`` to ``PlugIns`` directory of macOS app b
.. rst-class:: classref-method
|void| **add_shared_object**\ (\ path\: :ref:`String<class_String>`, tags\: :ref:`PackedStringArray<class_PackedStringArray>`, target\: :ref:`String<class_String>`\ )
|void| **add_shared_object**\ (\ path\: :ref:`String<class_String>`, tags\: :ref:`PackedStringArray<class_PackedStringArray>`, target\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_shared_object>`
Adds a shared object or a directory containing only shared objects with the given ``tags`` and destination ``path``.
@@ -593,7 +593,7 @@ In case of a directory code-sign will error if you place non code object in dire
.. rst-class:: classref-method
:ref:`Variant<class_Variant>` **get_option**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const|
:ref:`Variant<class_Variant>` **get_option**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_EditorExportPlugin_method_get_option>`
Returns the current value of an export option supplied by :ref:`_get_export_options<class_EditorExportPlugin_private_method__get_export_options>`.
@@ -605,9 +605,9 @@ Returns the current value of an export option supplied by :ref:`_get_export_opti
.. rst-class:: classref-method
|void| **skip**\ (\ )
|void| **skip**\ (\ ) :ref:`🔗<class_EditorExportPlugin_method_skip>`
To be called inside :ref:`_export_file<class_EditorExportPlugin_private_method__export_file>`. Skips the current file, so it's not included in the export.
To be called inside :ref:`_export_file<class_EditorExportPlugin_private_method__export_file>`, :ref:`_customize_resource<class_EditorExportPlugin_private_method__customize_resource>`, or :ref:`_customize_scene<class_EditorExportPlugin_private_method__customize_scene>`. Skips the current file, so it's not included in the export.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`