class_editorexportplatformios.rst 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/platform/ios/doc_classes/EditorExportPlatformIOS.xml.
  6. .. _class_EditorExportPlatformIOS:
  7. EditorExportPlatformIOS
  8. =======================
  9. **Inherits:** :ref:`EditorExportPlatform<class_EditorExportPlatform>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Exporter for iOS.
  11. .. rst-class:: classref-introduction-group
  12. Tutorials
  13. ---------
  14. - :doc:`Exporting for iOS <../tutorials/export/exporting_for_ios>`
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`String<class_String>` | :ref:`application/app_store_team_id<class_EditorExportPlatformIOS_property_application/app_store_team_id>` |
  22. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`String<class_String>` | :ref:`application/bundle_identifier<class_EditorExportPlatformIOS_property_application/bundle_identifier>` |
  24. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`String<class_String>` | :ref:`application/code_sign_identity_debug<class_EditorExportPlatformIOS_property_application/code_sign_identity_debug>` |
  26. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`String<class_String>` | :ref:`application/code_sign_identity_release<class_EditorExportPlatformIOS_property_application/code_sign_identity_release>` |
  28. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`int<class_int>` | :ref:`application/export_method_debug<class_EditorExportPlatformIOS_property_application/export_method_debug>` |
  30. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`int<class_int>` | :ref:`application/export_method_release<class_EditorExportPlatformIOS_property_application/export_method_release>` |
  32. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`bool<class_bool>` | :ref:`application/export_project_only<class_EditorExportPlatformIOS_property_application/export_project_only>` |
  34. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`int<class_int>` | :ref:`application/icon_interpolation<class_EditorExportPlatformIOS_property_application/icon_interpolation>` |
  36. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`int<class_int>` | :ref:`application/launch_screens_interpolation<class_EditorExportPlatformIOS_property_application/launch_screens_interpolation>` |
  38. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`String<class_String>` | :ref:`application/provisioning_profile_uuid_debug<class_EditorExportPlatformIOS_property_application/provisioning_profile_uuid_debug>` |
  40. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`String<class_String>` | :ref:`application/provisioning_profile_uuid_release<class_EditorExportPlatformIOS_property_application/provisioning_profile_uuid_release>` |
  42. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`String<class_String>` | :ref:`application/short_version<class_EditorExportPlatformIOS_property_application/short_version>` |
  44. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`String<class_String>` | :ref:`application/signature<class_EditorExportPlatformIOS_property_application/signature>` |
  46. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`int<class_int>` | :ref:`application/targeted_device_family<class_EditorExportPlatformIOS_property_application/targeted_device_family>` |
  48. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`String<class_String>` | :ref:`application/version<class_EditorExportPlatformIOS_property_application/version>` |
  50. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`bool<class_bool>` | :ref:`architectures/arm64<class_EditorExportPlatformIOS_property_architectures/arm64>` |
  52. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`bool<class_bool>` | :ref:`capabilities/access_wifi<class_EditorExportPlatformIOS_property_capabilities/access_wifi>` |
  54. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`bool<class_bool>` | :ref:`capabilities/push_notifications<class_EditorExportPlatformIOS_property_capabilities/push_notifications>` |
  56. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`String<class_String>` | :ref:`custom_template/debug<class_EditorExportPlatformIOS_property_custom_template/debug>` |
  58. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`String<class_String>` | :ref:`custom_template/release<class_EditorExportPlatformIOS_property_custom_template/release>` |
  60. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`String<class_String>` | :ref:`icons/app_store_1024x1024<class_EditorExportPlatformIOS_property_icons/app_store_1024x1024>` |
  62. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`String<class_String>` | :ref:`icons/ipad_76x76<class_EditorExportPlatformIOS_property_icons/ipad_76x76>` |
  64. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`String<class_String>` | :ref:`icons/ipad_152x152<class_EditorExportPlatformIOS_property_icons/ipad_152x152>` |
  66. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`String<class_String>` | :ref:`icons/ipad_167x167<class_EditorExportPlatformIOS_property_icons/ipad_167x167>` |
  68. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`String<class_String>` | :ref:`icons/iphone_120x120<class_EditorExportPlatformIOS_property_icons/iphone_120x120>` |
  70. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`String<class_String>` | :ref:`icons/iphone_180x180<class_EditorExportPlatformIOS_property_icons/iphone_180x180>` |
  72. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`String<class_String>` | :ref:`icons/notification_40x40<class_EditorExportPlatformIOS_property_icons/notification_40x40>` |
  74. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`String<class_String>` | :ref:`icons/notification_60x60<class_EditorExportPlatformIOS_property_icons/notification_60x60>` |
  76. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`String<class_String>` | :ref:`icons/settings_58x58<class_EditorExportPlatformIOS_property_icons/settings_58x58>` |
  78. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`String<class_String>` | :ref:`icons/settings_87x87<class_EditorExportPlatformIOS_property_icons/settings_87x87>` |
  80. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`String<class_String>` | :ref:`icons/spotlight_40x40<class_EditorExportPlatformIOS_property_icons/spotlight_40x40>` |
  82. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`String<class_String>` | :ref:`icons/spotlight_80x80<class_EditorExportPlatformIOS_property_icons/spotlight_80x80>` |
  84. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | :ref:`String<class_String>` | :ref:`landscape_launch_screens/ipad_1024x768<class_EditorExportPlatformIOS_property_landscape_launch_screens/ipad_1024x768>` |
  86. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | :ref:`String<class_String>` | :ref:`landscape_launch_screens/ipad_2048x1536<class_EditorExportPlatformIOS_property_landscape_launch_screens/ipad_2048x1536>` |
  88. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`String<class_String>` | :ref:`landscape_launch_screens/iphone_2208x1242<class_EditorExportPlatformIOS_property_landscape_launch_screens/iphone_2208x1242>` |
  90. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`String<class_String>` | :ref:`landscape_launch_screens/iphone_2436x1125<class_EditorExportPlatformIOS_property_landscape_launch_screens/iphone_2436x1125>` |
  92. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`String<class_String>` | :ref:`portrait_launch_screens/ipad_768x1024<class_EditorExportPlatformIOS_property_portrait_launch_screens/ipad_768x1024>` |
  94. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`String<class_String>` | :ref:`portrait_launch_screens/ipad_1536x2048<class_EditorExportPlatformIOS_property_portrait_launch_screens/ipad_1536x2048>` |
  96. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | :ref:`String<class_String>` | :ref:`portrait_launch_screens/iphone_640x960<class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_640x960>` |
  98. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`String<class_String>` | :ref:`portrait_launch_screens/iphone_640x1136<class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_640x1136>` |
  100. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`String<class_String>` | :ref:`portrait_launch_screens/iphone_750x1334<class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_750x1334>` |
  102. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`String<class_String>` | :ref:`portrait_launch_screens/iphone_1125x2436<class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_1125x2436>` |
  104. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`String<class_String>` | :ref:`portrait_launch_screens/iphone_1242x2208<class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_1242x2208>` |
  106. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`String<class_String>` | :ref:`privacy/camera_usage_description<class_EditorExportPlatformIOS_property_privacy/camera_usage_description>` |
  108. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/camera_usage_description_localized<class_EditorExportPlatformIOS_property_privacy/camera_usage_description_localized>` |
  110. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`String<class_String>` | :ref:`privacy/microphone_usage_description<class_EditorExportPlatformIOS_property_privacy/microphone_usage_description>` |
  112. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/microphone_usage_description_localized<class_EditorExportPlatformIOS_property_privacy/microphone_usage_description_localized>` |
  114. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`String<class_String>` | :ref:`privacy/photolibrary_usage_description<class_EditorExportPlatformIOS_property_privacy/photolibrary_usage_description>` |
  116. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/photolibrary_usage_description_localized<class_EditorExportPlatformIOS_property_privacy/photolibrary_usage_description_localized>` |
  118. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`Color<class_Color>` | :ref:`storyboard/custom_bg_color<class_EditorExportPlatformIOS_property_storyboard/custom_bg_color>` |
  120. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`String<class_String>` | :ref:`storyboard/custom_image@2x<class_EditorExportPlatformIOS_property_storyboard/custom_image@2x>` |
  122. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`String<class_String>` | :ref:`storyboard/custom_image@3x<class_EditorExportPlatformIOS_property_storyboard/custom_image@3x>` |
  124. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`int<class_int>` | :ref:`storyboard/image_scale_mode<class_EditorExportPlatformIOS_property_storyboard/image_scale_mode>` |
  126. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`bool<class_bool>` | :ref:`storyboard/use_custom_bg_color<class_EditorExportPlatformIOS_property_storyboard/use_custom_bg_color>` |
  128. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`bool<class_bool>` | :ref:`storyboard/use_launch_screen_storyboard<class_EditorExportPlatformIOS_property_storyboard/use_launch_screen_storyboard>` |
  130. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :ref:`bool<class_bool>` | :ref:`user_data/accessible_from_files_app<class_EditorExportPlatformIOS_property_user_data/accessible_from_files_app>` |
  132. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`bool<class_bool>` | :ref:`user_data/accessible_from_itunes_sharing<class_EditorExportPlatformIOS_property_user_data/accessible_from_itunes_sharing>` |
  134. +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  135. .. rst-class:: classref-section-separator
  136. ----
  137. .. rst-class:: classref-descriptions-group
  138. Property Descriptions
  139. ---------------------
  140. .. _class_EditorExportPlatformIOS_property_application/app_store_team_id:
  141. .. rst-class:: classref-property
  142. :ref:`String<class_String>` **application/app_store_team_id**
  143. 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>`__.
  144. .. rst-class:: classref-item-separator
  145. ----
  146. .. _class_EditorExportPlatformIOS_property_application/bundle_identifier:
  147. .. rst-class:: classref-property
  148. :ref:`String<class_String>` **application/bundle_identifier**
  149. Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (``A-Z``, ``a-z``, and ``0-9``), hyphens (``-``), and periods (``.``).
  150. .. rst-class:: classref-item-separator
  151. ----
  152. .. _class_EditorExportPlatformIOS_property_application/code_sign_identity_debug:
  153. .. rst-class:: classref-property
  154. :ref:`String<class_String>` **application/code_sign_identity_debug**
  155. The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for debug export.
  156. .. rst-class:: classref-item-separator
  157. ----
  158. .. _class_EditorExportPlatformIOS_property_application/code_sign_identity_release:
  159. .. rst-class:: classref-property
  160. :ref:`String<class_String>` **application/code_sign_identity_release**
  161. The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for release export.
  162. .. rst-class:: classref-item-separator
  163. ----
  164. .. _class_EditorExportPlatformIOS_property_application/export_method_debug:
  165. .. rst-class:: classref-property
  166. :ref:`int<class_int>` **application/export_method_debug**
  167. Application distribution target (debug export).
  168. .. rst-class:: classref-item-separator
  169. ----
  170. .. _class_EditorExportPlatformIOS_property_application/export_method_release:
  171. .. rst-class:: classref-property
  172. :ref:`int<class_int>` **application/export_method_release**
  173. Application distribution target (release export).
  174. .. rst-class:: classref-item-separator
  175. ----
  176. .. _class_EditorExportPlatformIOS_property_application/export_project_only:
  177. .. rst-class:: classref-property
  178. :ref:`bool<class_bool>` **application/export_project_only**
  179. 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``.
  180. .. rst-class:: classref-item-separator
  181. ----
  182. .. _class_EditorExportPlatformIOS_property_application/icon_interpolation:
  183. .. rst-class:: classref-property
  184. :ref:`int<class_int>` **application/icon_interpolation**
  185. Interpolation method used to resize application icon.
  186. .. rst-class:: classref-item-separator
  187. ----
  188. .. _class_EditorExportPlatformIOS_property_application/launch_screens_interpolation:
  189. .. rst-class:: classref-property
  190. :ref:`int<class_int>` **application/launch_screens_interpolation**
  191. Interpolation method used to resize launch screen images.
  192. .. rst-class:: classref-item-separator
  193. ----
  194. .. _class_EditorExportPlatformIOS_property_application/provisioning_profile_uuid_debug:
  195. .. rst-class:: classref-property
  196. :ref:`String<class_String>` **application/provisioning_profile_uuid_debug**
  197. 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>`__.
  198. Can be overridden with the environment variable ``GODOT_IOS_PROVISIONING_PROFILE_UUID_DEBUG``.
  199. .. rst-class:: classref-item-separator
  200. ----
  201. .. _class_EditorExportPlatformIOS_property_application/provisioning_profile_uuid_release:
  202. .. rst-class:: classref-property
  203. :ref:`String<class_String>` **application/provisioning_profile_uuid_release**
  204. 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>`__.
  205. Can be overridden with the environment variable ``GODOT_IOS_PROVISIONING_PROFILE_UUID_RELEASE``.
  206. .. rst-class:: classref-item-separator
  207. ----
  208. .. _class_EditorExportPlatformIOS_property_application/short_version:
  209. .. rst-class:: classref-property
  210. :ref:`String<class_String>` **application/short_version**
  211. 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.
  212. .. rst-class:: classref-item-separator
  213. ----
  214. .. _class_EditorExportPlatformIOS_property_application/signature:
  215. .. rst-class:: classref-property
  216. :ref:`String<class_String>` **application/signature**
  217. A four-character creator code that is specific to the bundle. Optional.
  218. .. rst-class:: classref-item-separator
  219. ----
  220. .. _class_EditorExportPlatformIOS_property_application/targeted_device_family:
  221. .. rst-class:: classref-property
  222. :ref:`int<class_int>` **application/targeted_device_family**
  223. Supported device family.
  224. .. rst-class:: classref-item-separator
  225. ----
  226. .. _class_EditorExportPlatformIOS_property_application/version:
  227. .. rst-class:: classref-property
  228. :ref:`String<class_String>` **application/version**
  229. 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.
  230. .. rst-class:: classref-item-separator
  231. ----
  232. .. _class_EditorExportPlatformIOS_property_architectures/arm64:
  233. .. rst-class:: classref-property
  234. :ref:`bool<class_bool>` **architectures/arm64**
  235. If ``true``, ``arm64`` binaries are included into exported project.
  236. .. rst-class:: classref-item-separator
  237. ----
  238. .. _class_EditorExportPlatformIOS_property_capabilities/access_wifi:
  239. .. rst-class:: classref-property
  240. :ref:`bool<class_bool>` **capabilities/access_wifi**
  241. If ``true``, networking features related to Wi-Fi access are enabled. See `Required Device Capabilities <https://developer.apple.com/support/required-device-capabilities/>`__.
  242. .. rst-class:: classref-item-separator
  243. ----
  244. .. _class_EditorExportPlatformIOS_property_capabilities/push_notifications:
  245. .. rst-class:: classref-property
  246. :ref:`bool<class_bool>` **capabilities/push_notifications**
  247. If ``true``, push notifications are enabled. See `Required Device Capabilities <https://developer.apple.com/support/required-device-capabilities/>`__.
  248. .. rst-class:: classref-item-separator
  249. ----
  250. .. _class_EditorExportPlatformIOS_property_custom_template/debug:
  251. .. rst-class:: classref-property
  252. :ref:`String<class_String>` **custom_template/debug**
  253. Path to the custom export template. If left empty, default template is used.
  254. .. rst-class:: classref-item-separator
  255. ----
  256. .. _class_EditorExportPlatformIOS_property_custom_template/release:
  257. .. rst-class:: classref-property
  258. :ref:`String<class_String>` **custom_template/release**
  259. Path to the custom export template. If left empty, default template is used.
  260. .. rst-class:: classref-item-separator
  261. ----
  262. .. _class_EditorExportPlatformIOS_property_icons/app_store_1024x1024:
  263. .. rst-class:: classref-property
  264. :ref:`String<class_String>` **icons/app_store_1024x1024**
  265. 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>`__.
  266. .. rst-class:: classref-item-separator
  267. ----
  268. .. _class_EditorExportPlatformIOS_property_icons/ipad_76x76:
  269. .. rst-class:: classref-property
  270. :ref:`String<class_String>` **icons/ipad_76x76**
  271. 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>`__.
  272. .. rst-class:: classref-item-separator
  273. ----
  274. .. _class_EditorExportPlatformIOS_property_icons/ipad_152x152:
  275. .. rst-class:: classref-property
  276. :ref:`String<class_String>` **icons/ipad_152x152**
  277. 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>`__.
  278. .. rst-class:: classref-item-separator
  279. ----
  280. .. _class_EditorExportPlatformIOS_property_icons/ipad_167x167:
  281. .. rst-class:: classref-property
  282. :ref:`String<class_String>` **icons/ipad_167x167**
  283. 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>`__.
  284. .. rst-class:: classref-item-separator
  285. ----
  286. .. _class_EditorExportPlatformIOS_property_icons/iphone_120x120:
  287. .. rst-class:: classref-property
  288. :ref:`String<class_String>` **icons/iphone_120x120**
  289. 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>`__.
  290. .. rst-class:: classref-item-separator
  291. ----
  292. .. _class_EditorExportPlatformIOS_property_icons/iphone_180x180:
  293. .. rst-class:: classref-property
  294. :ref:`String<class_String>` **icons/iphone_180x180**
  295. 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>`__.
  296. .. rst-class:: classref-item-separator
  297. ----
  298. .. _class_EditorExportPlatformIOS_property_icons/notification_40x40:
  299. .. rst-class:: classref-property
  300. :ref:`String<class_String>` **icons/notification_40x40**
  301. 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>`__.
  302. .. rst-class:: classref-item-separator
  303. ----
  304. .. _class_EditorExportPlatformIOS_property_icons/notification_60x60:
  305. .. rst-class:: classref-property
  306. :ref:`String<class_String>` **icons/notification_60x60**
  307. 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>`__.
  308. .. rst-class:: classref-item-separator
  309. ----
  310. .. _class_EditorExportPlatformIOS_property_icons/settings_58x58:
  311. .. rst-class:: classref-property
  312. :ref:`String<class_String>` **icons/settings_58x58**
  313. 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>`__.
  314. .. rst-class:: classref-item-separator
  315. ----
  316. .. _class_EditorExportPlatformIOS_property_icons/settings_87x87:
  317. .. rst-class:: classref-property
  318. :ref:`String<class_String>` **icons/settings_87x87**
  319. 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>`__.
  320. .. rst-class:: classref-item-separator
  321. ----
  322. .. _class_EditorExportPlatformIOS_property_icons/spotlight_40x40:
  323. .. rst-class:: classref-property
  324. :ref:`String<class_String>` **icons/spotlight_40x40**
  325. 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>`__.
  326. .. rst-class:: classref-item-separator
  327. ----
  328. .. _class_EditorExportPlatformIOS_property_icons/spotlight_80x80:
  329. .. rst-class:: classref-property
  330. :ref:`String<class_String>` **icons/spotlight_80x80**
  331. 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>`__.
  332. .. rst-class:: classref-item-separator
  333. ----
  334. .. _class_EditorExportPlatformIOS_property_landscape_launch_screens/ipad_1024x768:
  335. .. rst-class:: classref-property
  336. :ref:`String<class_String>` **landscape_launch_screens/ipad_1024x768**
  337. 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>`.
  338. .. rst-class:: classref-item-separator
  339. ----
  340. .. _class_EditorExportPlatformIOS_property_landscape_launch_screens/ipad_2048x1536:
  341. .. rst-class:: classref-property
  342. :ref:`String<class_String>` **landscape_launch_screens/ipad_2048x1536**
  343. 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>`.
  344. .. rst-class:: classref-item-separator
  345. ----
  346. .. _class_EditorExportPlatformIOS_property_landscape_launch_screens/iphone_2208x1242:
  347. .. rst-class:: classref-property
  348. :ref:`String<class_String>` **landscape_launch_screens/iphone_2208x1242**
  349. 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>`.
  350. .. rst-class:: classref-item-separator
  351. ----
  352. .. _class_EditorExportPlatformIOS_property_landscape_launch_screens/iphone_2436x1125:
  353. .. rst-class:: classref-property
  354. :ref:`String<class_String>` **landscape_launch_screens/iphone_2436x1125**
  355. 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>`.
  356. .. rst-class:: classref-item-separator
  357. ----
  358. .. _class_EditorExportPlatformIOS_property_portrait_launch_screens/ipad_768x1024:
  359. .. rst-class:: classref-property
  360. :ref:`String<class_String>` **portrait_launch_screens/ipad_768x1024**
  361. 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>`.
  362. .. rst-class:: classref-item-separator
  363. ----
  364. .. _class_EditorExportPlatformIOS_property_portrait_launch_screens/ipad_1536x2048:
  365. .. rst-class:: classref-property
  366. :ref:`String<class_String>` **portrait_launch_screens/ipad_1536x2048**
  367. 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>`.
  368. .. rst-class:: classref-item-separator
  369. ----
  370. .. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_640x960:
  371. .. rst-class:: classref-property
  372. :ref:`String<class_String>` **portrait_launch_screens/iphone_640x960**
  373. 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>`.
  374. .. rst-class:: classref-item-separator
  375. ----
  376. .. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_640x1136:
  377. .. rst-class:: classref-property
  378. :ref:`String<class_String>` **portrait_launch_screens/iphone_640x1136**
  379. 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>`.
  380. .. rst-class:: classref-item-separator
  381. ----
  382. .. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_750x1334:
  383. .. rst-class:: classref-property
  384. :ref:`String<class_String>` **portrait_launch_screens/iphone_750x1334**
  385. 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>`.
  386. .. rst-class:: classref-item-separator
  387. ----
  388. .. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_1125x2436:
  389. .. rst-class:: classref-property
  390. :ref:`String<class_String>` **portrait_launch_screens/iphone_1125x2436**
  391. 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>`.
  392. .. rst-class:: classref-item-separator
  393. ----
  394. .. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_1242x2208:
  395. .. rst-class:: classref-property
  396. :ref:`String<class_String>` **portrait_launch_screens/iphone_1242x2208**
  397. 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>`.
  398. .. rst-class:: classref-item-separator
  399. ----
  400. .. _class_EditorExportPlatformIOS_property_privacy/camera_usage_description:
  401. .. rst-class:: classref-property
  402. :ref:`String<class_String>` **privacy/camera_usage_description**
  403. A message displayed when requesting access to the device's camera (in English).
  404. .. rst-class:: classref-item-separator
  405. ----
  406. .. _class_EditorExportPlatformIOS_property_privacy/camera_usage_description_localized:
  407. .. rst-class:: classref-property
  408. :ref:`Dictionary<class_Dictionary>` **privacy/camera_usage_description_localized**
  409. A message displayed when requesting access to the device's camera (localized).
  410. .. rst-class:: classref-item-separator
  411. ----
  412. .. _class_EditorExportPlatformIOS_property_privacy/microphone_usage_description:
  413. .. rst-class:: classref-property
  414. :ref:`String<class_String>` **privacy/microphone_usage_description**
  415. A message displayed when requesting access to the device's microphone (in English).
  416. .. rst-class:: classref-item-separator
  417. ----
  418. .. _class_EditorExportPlatformIOS_property_privacy/microphone_usage_description_localized:
  419. .. rst-class:: classref-property
  420. :ref:`Dictionary<class_Dictionary>` **privacy/microphone_usage_description_localized**
  421. A message displayed when requesting access to the device's microphone (localized).
  422. .. rst-class:: classref-item-separator
  423. ----
  424. .. _class_EditorExportPlatformIOS_property_privacy/photolibrary_usage_description:
  425. .. rst-class:: classref-property
  426. :ref:`String<class_String>` **privacy/photolibrary_usage_description**
  427. A message displayed when requesting access to the user's photo library (in English).
  428. .. rst-class:: classref-item-separator
  429. ----
  430. .. _class_EditorExportPlatformIOS_property_privacy/photolibrary_usage_description_localized:
  431. .. rst-class:: classref-property
  432. :ref:`Dictionary<class_Dictionary>` **privacy/photolibrary_usage_description_localized**
  433. A message displayed when requesting access to the user's photo library (localized).
  434. .. rst-class:: classref-item-separator
  435. ----
  436. .. _class_EditorExportPlatformIOS_property_storyboard/custom_bg_color:
  437. .. rst-class:: classref-property
  438. :ref:`Color<class_Color>` **storyboard/custom_bg_color**
  439. A custom background color of the storyboard launch screen.
  440. .. rst-class:: classref-item-separator
  441. ----
  442. .. _class_EditorExportPlatformIOS_property_storyboard/custom_image@2x:
  443. .. rst-class:: classref-property
  444. :ref:`String<class_String>` **storyboard/custom_image@2x**
  445. 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>`.
  446. .. rst-class:: classref-item-separator
  447. ----
  448. .. _class_EditorExportPlatformIOS_property_storyboard/custom_image@3x:
  449. .. rst-class:: classref-property
  450. :ref:`String<class_String>` **storyboard/custom_image@3x**
  451. 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>`.
  452. .. rst-class:: classref-item-separator
  453. ----
  454. .. _class_EditorExportPlatformIOS_property_storyboard/image_scale_mode:
  455. .. rst-class:: classref-property
  456. :ref:`int<class_int>` **storyboard/image_scale_mode**
  457. Launch screen image scaling mode.
  458. .. rst-class:: classref-item-separator
  459. ----
  460. .. _class_EditorExportPlatformIOS_property_storyboard/use_custom_bg_color:
  461. .. rst-class:: classref-property
  462. :ref:`bool<class_bool>` **storyboard/use_custom_bg_color**
  463. 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.
  464. .. rst-class:: classref-item-separator
  465. ----
  466. .. _class_EditorExportPlatformIOS_property_storyboard/use_launch_screen_storyboard:
  467. .. rst-class:: classref-property
  468. :ref:`bool<class_bool>` **storyboard/use_launch_screen_storyboard**
  469. If ``true``, storyboard launch screen is used instead of launch screen images.
  470. .. rst-class:: classref-item-separator
  471. ----
  472. .. _class_EditorExportPlatformIOS_property_user_data/accessible_from_files_app:
  473. .. rst-class:: classref-property
  474. :ref:`bool<class_bool>` **user_data/accessible_from_files_app**
  475. If ``true``, the app "Documents" folder can be accessed via "Files" app. See `LSSupportsOpeningDocumentsInPlace <https://developer.apple.com/documentation/bundleresources/information_property_list/lssupportsopeningdocumentsinplace>`__.
  476. .. rst-class:: classref-item-separator
  477. ----
  478. .. _class_EditorExportPlatformIOS_property_user_data/accessible_from_itunes_sharing:
  479. .. rst-class:: classref-property
  480. :ref:`bool<class_bool>` **user_data/accessible_from_itunes_sharing**
  481. 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>`__.
  482. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  483. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  484. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  485. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  486. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  487. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  488. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`