mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
850 lines
46 KiB
ReStructuredText
850 lines
46 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/platform/ios/doc_classes/EditorExportPlatformIOS.xml.
|
|
|
|
.. _class_EditorExportPlatformIOS:
|
|
|
|
EditorExportPlatformIOS
|
|
=======================
|
|
|
|
**Inherits:** :ref:`EditorExportPlatform<class_EditorExportPlatform>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Exporter for iOS.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`Exporting for iOS <../tutorials/export/exporting_for_ios>`
|
|
|
|
- :doc:`iOS plugins documentation index <../tutorials/platform/ios/index>`
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`application/app_store_team_id<class_EditorExportPlatformIOS_property_application/app_store_team_id>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`application/bundle_identifier<class_EditorExportPlatformIOS_property_application/bundle_identifier>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`application/code_sign_identity_debug<class_EditorExportPlatformIOS_property_application/code_sign_identity_debug>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`application/code_sign_identity_release<class_EditorExportPlatformIOS_property_application/code_sign_identity_release>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`application/export_method_debug<class_EditorExportPlatformIOS_property_application/export_method_debug>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`application/export_method_release<class_EditorExportPlatformIOS_property_application/export_method_release>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`application/export_project_only<class_EditorExportPlatformIOS_property_application/export_project_only>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`application/icon_interpolation<class_EditorExportPlatformIOS_property_application/icon_interpolation>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`application/launch_screens_interpolation<class_EditorExportPlatformIOS_property_application/launch_screens_interpolation>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`application/provisioning_profile_uuid_debug<class_EditorExportPlatformIOS_property_application/provisioning_profile_uuid_debug>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`application/provisioning_profile_uuid_release<class_EditorExportPlatformIOS_property_application/provisioning_profile_uuid_release>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`application/short_version<class_EditorExportPlatformIOS_property_application/short_version>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`application/signature<class_EditorExportPlatformIOS_property_application/signature>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`application/targeted_device_family<class_EditorExportPlatformIOS_property_application/targeted_device_family>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`application/version<class_EditorExportPlatformIOS_property_application/version>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`architectures/arm64<class_EditorExportPlatformIOS_property_architectures/arm64>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`capabilities/access_wifi<class_EditorExportPlatformIOS_property_capabilities/access_wifi>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`capabilities/push_notifications<class_EditorExportPlatformIOS_property_capabilities/push_notifications>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`custom_template/debug<class_EditorExportPlatformIOS_property_custom_template/debug>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`custom_template/release<class_EditorExportPlatformIOS_property_custom_template/release>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/app_store_1024x1024<class_EditorExportPlatformIOS_property_icons/app_store_1024x1024>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/ipad_76x76<class_EditorExportPlatformIOS_property_icons/ipad_76x76>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/ipad_152x152<class_EditorExportPlatformIOS_property_icons/ipad_152x152>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/ipad_167x167<class_EditorExportPlatformIOS_property_icons/ipad_167x167>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/iphone_120x120<class_EditorExportPlatformIOS_property_icons/iphone_120x120>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/iphone_180x180<class_EditorExportPlatformIOS_property_icons/iphone_180x180>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/notification_40x40<class_EditorExportPlatformIOS_property_icons/notification_40x40>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/notification_60x60<class_EditorExportPlatformIOS_property_icons/notification_60x60>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/settings_58x58<class_EditorExportPlatformIOS_property_icons/settings_58x58>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/settings_87x87<class_EditorExportPlatformIOS_property_icons/settings_87x87>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/spotlight_40x40<class_EditorExportPlatformIOS_property_icons/spotlight_40x40>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`icons/spotlight_80x80<class_EditorExportPlatformIOS_property_icons/spotlight_80x80>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`landscape_launch_screens/ipad_1024x768<class_EditorExportPlatformIOS_property_landscape_launch_screens/ipad_1024x768>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`landscape_launch_screens/ipad_2048x1536<class_EditorExportPlatformIOS_property_landscape_launch_screens/ipad_2048x1536>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`landscape_launch_screens/iphone_2208x1242<class_EditorExportPlatformIOS_property_landscape_launch_screens/iphone_2208x1242>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`landscape_launch_screens/iphone_2436x1125<class_EditorExportPlatformIOS_property_landscape_launch_screens/iphone_2436x1125>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`portrait_launch_screens/ipad_768x1024<class_EditorExportPlatformIOS_property_portrait_launch_screens/ipad_768x1024>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`portrait_launch_screens/ipad_1536x2048<class_EditorExportPlatformIOS_property_portrait_launch_screens/ipad_1536x2048>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`portrait_launch_screens/iphone_640x960<class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_640x960>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`portrait_launch_screens/iphone_640x1136<class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_640x1136>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`portrait_launch_screens/iphone_750x1334<class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_750x1334>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`portrait_launch_screens/iphone_1125x2436<class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_1125x2436>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`portrait_launch_screens/iphone_1242x2208<class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_1242x2208>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`privacy/camera_usage_description<class_EditorExportPlatformIOS_property_privacy/camera_usage_description>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/camera_usage_description_localized<class_EditorExportPlatformIOS_property_privacy/camera_usage_description_localized>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`privacy/microphone_usage_description<class_EditorExportPlatformIOS_property_privacy/microphone_usage_description>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/microphone_usage_description_localized<class_EditorExportPlatformIOS_property_privacy/microphone_usage_description_localized>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`privacy/photolibrary_usage_description<class_EditorExportPlatformIOS_property_privacy/photolibrary_usage_description>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/photolibrary_usage_description_localized<class_EditorExportPlatformIOS_property_privacy/photolibrary_usage_description_localized>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`storyboard/custom_bg_color<class_EditorExportPlatformIOS_property_storyboard/custom_bg_color>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`storyboard/custom_image@2x<class_EditorExportPlatformIOS_property_storyboard/custom_image@2x>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`storyboard/custom_image@3x<class_EditorExportPlatformIOS_property_storyboard/custom_image@3x>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`storyboard/image_scale_mode<class_EditorExportPlatformIOS_property_storyboard/image_scale_mode>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`storyboard/use_custom_bg_color<class_EditorExportPlatformIOS_property_storyboard/use_custom_bg_color>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`storyboard/use_launch_screen_storyboard<class_EditorExportPlatformIOS_property_storyboard/use_launch_screen_storyboard>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`user_data/accessible_from_files_app<class_EditorExportPlatformIOS_property_user_data/accessible_from_files_app>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`user_data/accessible_from_itunes_sharing<class_EditorExportPlatformIOS_property_user_data/accessible_from_itunes_sharing>` |
|
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/app_store_team_id:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **application/app_store_team_id**
|
|
|
|
Apple Team ID, unique 10-character string. To locate your Team ID check "Membership details" section in your Apple developer account dashboard, or "Organizational Unit" of your code signing certificate. See `Locate your Team ID <https://developer.apple.com/help/account/manage-your-team/locate-your-team-id>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/bundle_identifier:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **application/bundle_identifier**
|
|
|
|
Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (``A-Z``, ``a-z``, and ``0-9``), hyphens (``-``), and periods (``.``).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/code_sign_identity_debug:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **application/code_sign_identity_debug**
|
|
|
|
The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for debug export.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/code_sign_identity_release:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **application/code_sign_identity_release**
|
|
|
|
The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for release export.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/export_method_debug:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **application/export_method_debug**
|
|
|
|
Application distribution target (debug export).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/export_method_release:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **application/export_method_release**
|
|
|
|
Application distribution target (release export).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/export_project_only:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **application/export_project_only**
|
|
|
|
If ``true``, exports iOS project files without building an XCArchive or ``.ipa`` file. If ``false``, exports iOS project files and builds an XCArchive and ``.ipa`` file at the same time. When combining Godot with Fastlane or other build pipelines, you may want to set this to ``true``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/icon_interpolation:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **application/icon_interpolation**
|
|
|
|
Interpolation method used to resize application icon.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/launch_screens_interpolation:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **application/launch_screens_interpolation**
|
|
|
|
Interpolation method used to resize launch screen images.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/provisioning_profile_uuid_debug:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **application/provisioning_profile_uuid_debug**
|
|
|
|
UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See `Edit, download, or delete provisioning profiles <https://developer.apple.com/help/account/manage-profiles/edit-download-or-delete-profiles>`__.
|
|
|
|
Can be overridden with the environment variable ``GODOT_IOS_PROVISIONING_PROFILE_UUID_DEBUG``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/provisioning_profile_uuid_release:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **application/provisioning_profile_uuid_release**
|
|
|
|
UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See `Edit, download, or delete provisioning profiles <https://developer.apple.com/help/account/manage-profiles/edit-download-or-delete-profiles>`__.
|
|
|
|
Can be overridden with the environment variable ``GODOT_IOS_PROVISIONING_PROFILE_UUID_RELEASE``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/short_version:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **application/short_version**
|
|
|
|
Application version visible to the user, can only contain numeric characters (``0-9``) and periods (``.``). Falls back to :ref:`ProjectSettings.application/config/version<class_ProjectSettings_property_application/config/version>` if left empty.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/signature:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **application/signature**
|
|
|
|
A four-character creator code that is specific to the bundle. Optional.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/targeted_device_family:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **application/targeted_device_family**
|
|
|
|
Supported device family.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_application/version:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **application/version**
|
|
|
|
Machine-readable application version, in the ``major.minor.patch`` format, can only contain numeric characters (``0-9``) and periods (``.``). This must be incremented on every new release pushed to the App Store.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_architectures/arm64:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **architectures/arm64**
|
|
|
|
If ``true``, ``arm64`` binaries are included into exported project.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_capabilities/access_wifi:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **capabilities/access_wifi**
|
|
|
|
If ``true``, networking features related to Wi-Fi access are enabled. See `Required Device Capabilities <https://developer.apple.com/support/required-device-capabilities/>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_capabilities/push_notifications:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **capabilities/push_notifications**
|
|
|
|
If ``true``, push notifications are enabled. See `Required Device Capabilities <https://developer.apple.com/support/required-device-capabilities/>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_custom_template/debug:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **custom_template/debug**
|
|
|
|
Path to the custom export template. If left empty, default template is used.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_custom_template/release:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **custom_template/release**
|
|
|
|
Path to the custom export template. If left empty, default template is used.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/app_store_1024x1024:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/app_store_1024x1024**
|
|
|
|
App Store application icon file. If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/ipad_76x76:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/ipad_76x76**
|
|
|
|
Home screen application icon file on iPad (1x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/ipad_152x152:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/ipad_152x152**
|
|
|
|
Home screen application icon file on iPad (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/ipad_167x167:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/ipad_167x167**
|
|
|
|
Home screen application icon file on iPad (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/iphone_120x120:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/iphone_120x120**
|
|
|
|
Home screen application icon file on iPhone (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/iphone_180x180:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/iphone_180x180**
|
|
|
|
Home screen application icon file on iPhone (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/notification_40x40:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/notification_40x40**
|
|
|
|
Notification icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/notification_60x60:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/notification_60x60**
|
|
|
|
Notification icon file on iPhone (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/settings_58x58:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/settings_58x58**
|
|
|
|
Application settings icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/settings_87x87:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/settings_87x87**
|
|
|
|
Application settings icon file on iPhone (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/spotlight_40x40:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/spotlight_40x40**
|
|
|
|
Spotlight icon file on iPad (1x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_icons/spotlight_80x80:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **icons/spotlight_80x80**
|
|
|
|
Spotlight icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`. See `App icons <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_landscape_launch_screens/ipad_1024x768:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **landscape_launch_screens/ipad_1024x768**
|
|
|
|
Application launch screen image file. If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_landscape_launch_screens/ipad_2048x1536:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **landscape_launch_screens/ipad_2048x1536**
|
|
|
|
Application launch screen image file. If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_landscape_launch_screens/iphone_2208x1242:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **landscape_launch_screens/iphone_2208x1242**
|
|
|
|
Application launch screen image file. If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_landscape_launch_screens/iphone_2436x1125:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **landscape_launch_screens/iphone_2436x1125**
|
|
|
|
Application launch screen image file. If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/ipad_768x1024:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **portrait_launch_screens/ipad_768x1024**
|
|
|
|
Application launch screen image file. If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/ipad_1536x2048:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **portrait_launch_screens/ipad_1536x2048**
|
|
|
|
Application launch screen image file. If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_640x960:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **portrait_launch_screens/iphone_640x960**
|
|
|
|
Application launch screen image file. If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_640x1136:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **portrait_launch_screens/iphone_640x1136**
|
|
|
|
Application launch screen image file. If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_750x1334:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **portrait_launch_screens/iphone_750x1334**
|
|
|
|
Application launch screen image file. If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_1125x2436:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **portrait_launch_screens/iphone_1125x2436**
|
|
|
|
Application launch screen image file. If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_1242x2208:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **portrait_launch_screens/iphone_1242x2208**
|
|
|
|
Application launch screen image file. If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_privacy/camera_usage_description:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **privacy/camera_usage_description**
|
|
|
|
A message displayed when requesting access to the device's camera (in English).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_privacy/camera_usage_description_localized:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Dictionary<class_Dictionary>` **privacy/camera_usage_description_localized**
|
|
|
|
A message displayed when requesting access to the device's camera (localized).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_privacy/microphone_usage_description:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **privacy/microphone_usage_description**
|
|
|
|
A message displayed when requesting access to the device's microphone (in English).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_privacy/microphone_usage_description_localized:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Dictionary<class_Dictionary>` **privacy/microphone_usage_description_localized**
|
|
|
|
A message displayed when requesting access to the device's microphone (localized).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_privacy/photolibrary_usage_description:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **privacy/photolibrary_usage_description**
|
|
|
|
A message displayed when requesting access to the user's photo library (in English).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_privacy/photolibrary_usage_description_localized:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Dictionary<class_Dictionary>` **privacy/photolibrary_usage_description_localized**
|
|
|
|
A message displayed when requesting access to the user's photo library (localized).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_storyboard/custom_bg_color:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Color<class_Color>` **storyboard/custom_bg_color**
|
|
|
|
A custom background color of the storyboard launch screen.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_storyboard/custom_image@2x:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **storyboard/custom_image@2x**
|
|
|
|
Application launch screen image file (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_storyboard/custom_image@3x:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`String<class_String>` **storyboard/custom_image@3x**
|
|
|
|
Application launch screen image file (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_storyboard/image_scale_mode:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **storyboard/image_scale_mode**
|
|
|
|
Launch screen image scaling mode.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_storyboard/use_custom_bg_color:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **storyboard/use_custom_bg_color**
|
|
|
|
If ``true``, :ref:`storyboard/custom_bg_color<class_EditorExportPlatformIOS_property_storyboard/custom_bg_color>` is used as a launch screen background color, otherwise ``application/boot_splash/bg_color`` project setting is used.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_storyboard/use_launch_screen_storyboard:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **storyboard/use_launch_screen_storyboard**
|
|
|
|
If ``true``, storyboard launch screen is used instead of launch screen images.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_user_data/accessible_from_files_app:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **user_data/accessible_from_files_app**
|
|
|
|
If ``true``, the app "Documents" folder can be accessed via "Files" app. See `LSSupportsOpeningDocumentsInPlace <https://developer.apple.com/documentation/bundleresources/information_property_list/lssupportsopeningdocumentsinplace>`__.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_EditorExportPlatformIOS_property_user_data/accessible_from_itunes_sharing:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **user_data/accessible_from_itunes_sharing**
|
|
|
|
If ``true``, the app "Documents" folder can be accessed via iTunes file sharing. See `UIFileSharingEnabled <https://developer.apple.com/documentation/bundleresources/information_property_list/uifilesharingenabled>`__.
|
|
|
|
.. |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.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |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.)`
|