class_editorexportplatformmacos.rst 74 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335
  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/macos/doc_classes/EditorExportPlatformMacOS.xml.
  6. .. _class_EditorExportPlatformMacOS:
  7. EditorExportPlatformMacOS
  8. =========================
  9. **Inherits:** :ref:`EditorExportPlatform<class_EditorExportPlatform>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Exporter for macOS.
  11. .. rst-class:: classref-introduction-group
  12. Tutorials
  13. ---------
  14. - :doc:`Exporting for macOS <../tutorials/export/exporting_for_macos>`
  15. - :doc:`Running Godot apps on macOS <../tutorials//export/running_on_macos>`
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`String<class_String>` | :ref:`application/app_category<class_EditorExportPlatformMacOS_property_application/app_category>` |
  23. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`String<class_String>` | :ref:`application/bundle_identifier<class_EditorExportPlatformMacOS_property_application/bundle_identifier>` |
  25. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`String<class_String>` | :ref:`application/copyright<class_EditorExportPlatformMacOS_property_application/copyright>` |
  27. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`Dictionary<class_Dictionary>` | :ref:`application/copyright_localized<class_EditorExportPlatformMacOS_property_application/copyright_localized>` |
  29. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`String<class_String>` | :ref:`application/icon<class_EditorExportPlatformMacOS_property_application/icon>` |
  31. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`int<class_int>` | :ref:`application/icon_interpolation<class_EditorExportPlatformMacOS_property_application/icon_interpolation>` |
  33. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`String<class_String>` | :ref:`application/min_macos_version<class_EditorExportPlatformMacOS_property_application/min_macos_version>` |
  35. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`String<class_String>` | :ref:`application/short_version<class_EditorExportPlatformMacOS_property_application/short_version>` |
  37. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`String<class_String>` | :ref:`application/signature<class_EditorExportPlatformMacOS_property_application/signature>` |
  39. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`String<class_String>` | :ref:`application/version<class_EditorExportPlatformMacOS_property_application/version>` |
  41. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`String<class_String>` | :ref:`binary_format/architecture<class_EditorExportPlatformMacOS_property_binary_format/architecture>` |
  43. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`String<class_String>` | :ref:`codesign/apple_team_id<class_EditorExportPlatformMacOS_property_codesign/apple_team_id>` |
  45. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`String<class_String>` | :ref:`codesign/certificate_file<class_EditorExportPlatformMacOS_property_codesign/certificate_file>` |
  47. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`String<class_String>` | :ref:`codesign/certificate_password<class_EditorExportPlatformMacOS_property_codesign/certificate_password>` |
  49. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`int<class_int>` | :ref:`codesign/codesign<class_EditorExportPlatformMacOS_property_codesign/codesign>` |
  51. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`codesign/custom_options<class_EditorExportPlatformMacOS_property_codesign/custom_options>` |
  53. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/address_book<class_EditorExportPlatformMacOS_property_codesign/entitlements/address_book>` |
  55. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/allow_dyld_environment_variables<class_EditorExportPlatformMacOS_property_codesign/entitlements/allow_dyld_environment_variables>` |
  57. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/allow_jit_code_execution<class_EditorExportPlatformMacOS_property_codesign/entitlements/allow_jit_code_execution>` |
  59. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/allow_unsigned_executable_memory<class_EditorExportPlatformMacOS_property_codesign/entitlements/allow_unsigned_executable_memory>` |
  61. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/app_sandbox/device_bluetooth<class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/device_bluetooth>` |
  63. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/app_sandbox/device_usb<class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/device_usb>` |
  65. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/app_sandbox/enabled<class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/enabled>` |
  67. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`int<class_int>` | :ref:`codesign/entitlements/app_sandbox/files_downloads<class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_downloads>` |
  69. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`int<class_int>` | :ref:`codesign/entitlements/app_sandbox/files_movies<class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_movies>` |
  71. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`int<class_int>` | :ref:`codesign/entitlements/app_sandbox/files_music<class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_music>` |
  73. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`int<class_int>` | :ref:`codesign/entitlements/app_sandbox/files_pictures<class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_pictures>` |
  75. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`int<class_int>` | :ref:`codesign/entitlements/app_sandbox/files_user_selected<class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_user_selected>` |
  77. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`Array<class_Array>` | :ref:`codesign/entitlements/app_sandbox/helper_executables<class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/helper_executables>` |
  79. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/app_sandbox/network_client<class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/network_client>` |
  81. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/app_sandbox/network_server<class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/network_server>` |
  83. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/apple_events<class_EditorExportPlatformMacOS_property_codesign/entitlements/apple_events>` |
  85. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/audio_input<class_EditorExportPlatformMacOS_property_codesign/entitlements/audio_input>` |
  87. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/calendars<class_EditorExportPlatformMacOS_property_codesign/entitlements/calendars>` |
  89. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/camera<class_EditorExportPlatformMacOS_property_codesign/entitlements/camera>` |
  91. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`String<class_String>` | :ref:`codesign/entitlements/custom_file<class_EditorExportPlatformMacOS_property_codesign/entitlements/custom_file>` |
  93. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/debugging<class_EditorExportPlatformMacOS_property_codesign/entitlements/debugging>` |
  95. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/disable_library_validation<class_EditorExportPlatformMacOS_property_codesign/entitlements/disable_library_validation>` |
  97. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/location<class_EditorExportPlatformMacOS_property_codesign/entitlements/location>` |
  99. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :ref:`bool<class_bool>` | :ref:`codesign/entitlements/photos_library<class_EditorExportPlatformMacOS_property_codesign/entitlements/photos_library>` |
  101. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | :ref:`String<class_String>` | :ref:`codesign/identity<class_EditorExportPlatformMacOS_property_codesign/identity>` |
  103. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`String<class_String>` | :ref:`codesign/installer_identity<class_EditorExportPlatformMacOS_property_codesign/installer_identity>` |
  105. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`String<class_String>` | :ref:`codesign/provisioning_profile<class_EditorExportPlatformMacOS_property_codesign/provisioning_profile>` |
  107. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :ref:`String<class_String>` | :ref:`custom_template/debug<class_EditorExportPlatformMacOS_property_custom_template/debug>` |
  109. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`String<class_String>` | :ref:`custom_template/release<class_EditorExportPlatformMacOS_property_custom_template/release>` |
  111. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | :ref:`int<class_int>` | :ref:`debug/export_console_wrapper<class_EditorExportPlatformMacOS_property_debug/export_console_wrapper>` |
  113. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`bool<class_bool>` | :ref:`display/high_res<class_EditorExportPlatformMacOS_property_display/high_res>` |
  115. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | :ref:`int<class_int>` | :ref:`export/distribution_type<class_EditorExportPlatformMacOS_property_export/distribution_type>` |
  117. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | :ref:`String<class_String>` | :ref:`notarization/api_key<class_EditorExportPlatformMacOS_property_notarization/api_key>` |
  119. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :ref:`String<class_String>` | :ref:`notarization/api_key_id<class_EditorExportPlatformMacOS_property_notarization/api_key_id>` |
  121. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :ref:`String<class_String>` | :ref:`notarization/api_uuid<class_EditorExportPlatformMacOS_property_notarization/api_uuid>` |
  123. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | :ref:`String<class_String>` | :ref:`notarization/apple_id_name<class_EditorExportPlatformMacOS_property_notarization/apple_id_name>` |
  125. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | :ref:`String<class_String>` | :ref:`notarization/apple_id_password<class_EditorExportPlatformMacOS_property_notarization/apple_id_password>` |
  127. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | :ref:`int<class_int>` | :ref:`notarization/notarization<class_EditorExportPlatformMacOS_property_notarization/notarization>` |
  129. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | :ref:`String<class_String>` | :ref:`privacy/address_book_usage_description<class_EditorExportPlatformMacOS_property_privacy/address_book_usage_description>` |
  131. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/address_book_usage_description_localized<class_EditorExportPlatformMacOS_property_privacy/address_book_usage_description_localized>` |
  133. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :ref:`String<class_String>` | :ref:`privacy/calendar_usage_description<class_EditorExportPlatformMacOS_property_privacy/calendar_usage_description>` |
  135. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/calendar_usage_description_localized<class_EditorExportPlatformMacOS_property_privacy/calendar_usage_description_localized>` |
  137. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | :ref:`String<class_String>` | :ref:`privacy/camera_usage_description<class_EditorExportPlatformMacOS_property_privacy/camera_usage_description>` |
  139. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/camera_usage_description_localized<class_EditorExportPlatformMacOS_property_privacy/camera_usage_description_localized>` |
  141. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | :ref:`String<class_String>` | :ref:`privacy/desktop_folder_usage_description<class_EditorExportPlatformMacOS_property_privacy/desktop_folder_usage_description>` |
  143. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/desktop_folder_usage_description_localized<class_EditorExportPlatformMacOS_property_privacy/desktop_folder_usage_description_localized>` |
  145. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | :ref:`String<class_String>` | :ref:`privacy/documents_folder_usage_description<class_EditorExportPlatformMacOS_property_privacy/documents_folder_usage_description>` |
  147. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/documents_folder_usage_description_localized<class_EditorExportPlatformMacOS_property_privacy/documents_folder_usage_description_localized>` |
  149. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | :ref:`String<class_String>` | :ref:`privacy/downloads_folder_usage_description<class_EditorExportPlatformMacOS_property_privacy/downloads_folder_usage_description>` |
  151. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/downloads_folder_usage_description_localized<class_EditorExportPlatformMacOS_property_privacy/downloads_folder_usage_description_localized>` |
  153. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | :ref:`String<class_String>` | :ref:`privacy/location_usage_description<class_EditorExportPlatformMacOS_property_privacy/location_usage_description>` |
  155. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/location_usage_description_localized<class_EditorExportPlatformMacOS_property_privacy/location_usage_description_localized>` |
  157. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | :ref:`String<class_String>` | :ref:`privacy/microphone_usage_description<class_EditorExportPlatformMacOS_property_privacy/microphone_usage_description>` |
  159. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/microphone_usage_description_localized<class_EditorExportPlatformMacOS_property_privacy/microphone_usage_description_localized>` |
  161. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | :ref:`String<class_String>` | :ref:`privacy/network_volumes_usage_description<class_EditorExportPlatformMacOS_property_privacy/network_volumes_usage_description>` |
  163. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/network_volumes_usage_description_localized<class_EditorExportPlatformMacOS_property_privacy/network_volumes_usage_description_localized>` |
  165. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | :ref:`String<class_String>` | :ref:`privacy/photos_library_usage_description<class_EditorExportPlatformMacOS_property_privacy/photos_library_usage_description>` |
  167. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/photos_library_usage_description_localized<class_EditorExportPlatformMacOS_property_privacy/photos_library_usage_description_localized>` |
  169. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | :ref:`String<class_String>` | :ref:`privacy/removable_volumes_usage_description<class_EditorExportPlatformMacOS_property_privacy/removable_volumes_usage_description>` |
  171. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | :ref:`Dictionary<class_Dictionary>` | :ref:`privacy/removable_volumes_usage_description_localized<class_EditorExportPlatformMacOS_property_privacy/removable_volumes_usage_description_localized>` |
  173. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/cleanup_script<class_EditorExportPlatformMacOS_property_ssh_remote_deploy/cleanup_script>` |
  175. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | :ref:`bool<class_bool>` | :ref:`ssh_remote_deploy/enabled<class_EditorExportPlatformMacOS_property_ssh_remote_deploy/enabled>` |
  177. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/extra_args_scp<class_EditorExportPlatformMacOS_property_ssh_remote_deploy/extra_args_scp>` |
  179. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/extra_args_ssh<class_EditorExportPlatformMacOS_property_ssh_remote_deploy/extra_args_ssh>` |
  181. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/host<class_EditorExportPlatformMacOS_property_ssh_remote_deploy/host>` |
  183. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/port<class_EditorExportPlatformMacOS_property_ssh_remote_deploy/port>` |
  185. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/run_script<class_EditorExportPlatformMacOS_property_ssh_remote_deploy/run_script>` |
  187. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | :ref:`String<class_String>` | :ref:`xcode/platform_build<class_EditorExportPlatformMacOS_property_xcode/platform_build>` |
  189. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | :ref:`String<class_String>` | :ref:`xcode/sdk_build<class_EditorExportPlatformMacOS_property_xcode/sdk_build>` |
  191. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | :ref:`String<class_String>` | :ref:`xcode/sdk_name<class_EditorExportPlatformMacOS_property_xcode/sdk_name>` |
  193. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | :ref:`String<class_String>` | :ref:`xcode/sdk_version<class_EditorExportPlatformMacOS_property_xcode/sdk_version>` |
  195. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | :ref:`String<class_String>` | :ref:`xcode/xcode_build<class_EditorExportPlatformMacOS_property_xcode/xcode_build>` |
  197. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | :ref:`String<class_String>` | :ref:`xcode/xcode_version<class_EditorExportPlatformMacOS_property_xcode/xcode_version>` |
  199. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. .. rst-class:: classref-section-separator
  201. ----
  202. .. rst-class:: classref-descriptions-group
  203. Property Descriptions
  204. ---------------------
  205. .. _class_EditorExportPlatformMacOS_property_application/app_category:
  206. .. rst-class:: classref-property
  207. :ref:`String<class_String>` **application/app_category**
  208. Application category for the App Store.
  209. .. rst-class:: classref-item-separator
  210. ----
  211. .. _class_EditorExportPlatformMacOS_property_application/bundle_identifier:
  212. .. rst-class:: classref-property
  213. :ref:`String<class_String>` **application/bundle_identifier**
  214. Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (``A-Z``, ``a-z``, and ``0-9``), hyphens (``-``), and periods (``.``).
  215. .. rst-class:: classref-item-separator
  216. ----
  217. .. _class_EditorExportPlatformMacOS_property_application/copyright:
  218. .. rst-class:: classref-property
  219. :ref:`String<class_String>` **application/copyright**
  220. Copyright notice for the bundle visible to the user (in English).
  221. .. rst-class:: classref-item-separator
  222. ----
  223. .. _class_EditorExportPlatformMacOS_property_application/copyright_localized:
  224. .. rst-class:: classref-property
  225. :ref:`Dictionary<class_Dictionary>` **application/copyright_localized**
  226. Copyright notice for the bundle visible to the user (localized).
  227. .. rst-class:: classref-item-separator
  228. ----
  229. .. _class_EditorExportPlatformMacOS_property_application/icon:
  230. .. rst-class:: classref-property
  231. :ref:`String<class_String>` **application/icon**
  232. Application icon file. If left empty, it will fallback to :ref:`ProjectSettings.application/config/macos_native_icon<class_ProjectSettings_property_application/config/macos_native_icon>`, and then to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`.
  233. .. rst-class:: classref-item-separator
  234. ----
  235. .. _class_EditorExportPlatformMacOS_property_application/icon_interpolation:
  236. .. rst-class:: classref-property
  237. :ref:`int<class_int>` **application/icon_interpolation**
  238. Interpolation method used to resize application icon.
  239. .. rst-class:: classref-item-separator
  240. ----
  241. .. _class_EditorExportPlatformMacOS_property_application/min_macos_version:
  242. .. rst-class:: classref-property
  243. :ref:`String<class_String>` **application/min_macos_version**
  244. Minimum version of macOS required for this application to run in the ``major.minor.patch`` or ``major.minor`` format, can only contain numeric characters (``0-9``) and periods (``.``).
  245. .. rst-class:: classref-item-separator
  246. ----
  247. .. _class_EditorExportPlatformMacOS_property_application/short_version:
  248. .. rst-class:: classref-property
  249. :ref:`String<class_String>` **application/short_version**
  250. Application version visible to the user, can only contain numeric characters (``0-9``) and periods (``.``).
  251. .. rst-class:: classref-item-separator
  252. ----
  253. .. _class_EditorExportPlatformMacOS_property_application/signature:
  254. .. rst-class:: classref-property
  255. :ref:`String<class_String>` **application/signature**
  256. A four-character creator code that is specific to the bundle. Optional.
  257. .. rst-class:: classref-item-separator
  258. ----
  259. .. _class_EditorExportPlatformMacOS_property_application/version:
  260. .. rst-class:: classref-property
  261. :ref:`String<class_String>` **application/version**
  262. Machine-readable application version, in the ``major.minor.patch`` format, can only contain numeric characters (``0-9``) and periods (``.``).
  263. .. rst-class:: classref-item-separator
  264. ----
  265. .. _class_EditorExportPlatformMacOS_property_binary_format/architecture:
  266. .. rst-class:: classref-property
  267. :ref:`String<class_String>` **binary_format/architecture**
  268. Application executable architecture.
  269. Supported architectures: ``x86_64``, ``arm64``, and ``universal`` (``x86_64 + arm64``).
  270. Official export templates include ``universal`` binaries only.
  271. .. rst-class:: classref-item-separator
  272. ----
  273. .. _class_EditorExportPlatformMacOS_property_codesign/apple_team_id:
  274. .. rst-class:: classref-property
  275. :ref:`String<class_String>` **codesign/apple_team_id**
  276. 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>`__.
  277. .. rst-class:: classref-item-separator
  278. ----
  279. .. _class_EditorExportPlatformMacOS_property_codesign/certificate_file:
  280. .. rst-class:: classref-property
  281. :ref:`String<class_String>` **codesign/certificate_file**
  282. PKCS #12 certificate file used to sign ``.app`` bundle.
  283. Can be overridden with the environment variable ``GODOT_MACOS_CODESIGN_CERTIFICATE_FILE``.
  284. .. rst-class:: classref-item-separator
  285. ----
  286. .. _class_EditorExportPlatformMacOS_property_codesign/certificate_password:
  287. .. rst-class:: classref-property
  288. :ref:`String<class_String>` **codesign/certificate_password**
  289. Password for the certificate file used to sign ``.app`` bundle.
  290. Can be overridden with the environment variable ``GODOT_MACOS_CODESIGN_CERTIFICATE_PASSWORD``.
  291. .. rst-class:: classref-item-separator
  292. ----
  293. .. _class_EditorExportPlatformMacOS_property_codesign/codesign:
  294. .. rst-class:: classref-property
  295. :ref:`int<class_int>` **codesign/codesign**
  296. Tool to use for code signing.
  297. .. rst-class:: classref-item-separator
  298. ----
  299. .. _class_EditorExportPlatformMacOS_property_codesign/custom_options:
  300. .. rst-class:: classref-property
  301. :ref:`PackedStringArray<class_PackedStringArray>` **codesign/custom_options**
  302. Array of the additional command line arguments passed to the code signing tool.
  303. .. rst-class:: classref-item-separator
  304. ----
  305. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/address_book:
  306. .. rst-class:: classref-property
  307. :ref:`bool<class_bool>` **codesign/entitlements/address_book**
  308. Enable to allow access to contacts in the user's address book, if it's enabled you should also provide usage message in the ``privacy/address_book_usage_description`` option. See `com.apple.security.personal-information.addressbook <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_personal-information_addressbook>`__.
  309. .. rst-class:: classref-item-separator
  310. ----
  311. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/allow_dyld_environment_variables:
  312. .. rst-class:: classref-property
  313. :ref:`bool<class_bool>` **codesign/entitlements/allow_dyld_environment_variables**
  314. Allows app to use dynamic linker environment variables to inject code. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation. See `com.apple.security.cs.allow-dyld-environment-variables <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_cs_allow-dyld-environment-variables>`__.
  315. .. rst-class:: classref-item-separator
  316. ----
  317. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/allow_jit_code_execution:
  318. .. rst-class:: classref-property
  319. :ref:`bool<class_bool>` **codesign/entitlements/allow_jit_code_execution**
  320. Allows creating writable and executable memory for JIT code. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation. See `com.apple.security.cs.allow-jit <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_cs_allow-jit>`__.
  321. .. rst-class:: classref-item-separator
  322. ----
  323. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/allow_unsigned_executable_memory:
  324. .. rst-class:: classref-property
  325. :ref:`bool<class_bool>` **codesign/entitlements/allow_unsigned_executable_memory**
  326. Allows creating writable and executable memory without JIT restrictions. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation. See `com.apple.security.cs.allow-unsigned-executable-memory <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_cs_allow-unsigned-executable-memory>`__.
  327. .. rst-class:: classref-item-separator
  328. ----
  329. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/device_bluetooth:
  330. .. rst-class:: classref-property
  331. :ref:`bool<class_bool>` **codesign/entitlements/app_sandbox/device_bluetooth**
  332. Enable to allow app to interact with Bluetooth devices. This entitlement is required to use wireless controllers. See `com.apple.security.device.bluetooth <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_device_bluetooth>`__.
  333. .. rst-class:: classref-item-separator
  334. ----
  335. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/device_usb:
  336. .. rst-class:: classref-property
  337. :ref:`bool<class_bool>` **codesign/entitlements/app_sandbox/device_usb**
  338. Enable to allow app to interact with USB devices. This entitlement is required to use wired controllers. See `com.apple.security.device.usb <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_device_usb>`__.
  339. .. rst-class:: classref-item-separator
  340. ----
  341. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/enabled:
  342. .. rst-class:: classref-property
  343. :ref:`bool<class_bool>` **codesign/entitlements/app_sandbox/enabled**
  344. Enables App Sandbox. The App Sandbox restricts access to user data, networking, and devices. Sandboxed apps can't access most of the file system, can't use custom file dialogs and execute binaries outside the .app bundle. See `App Sandbox <https://developer.apple.com/documentation/security/app_sandbox>`__.
  345. \ **Note:** To distribute an app through the App Store, you must enable the App Sandbox.
  346. .. rst-class:: classref-item-separator
  347. ----
  348. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_downloads:
  349. .. rst-class:: classref-property
  350. :ref:`int<class_int>` **codesign/entitlements/app_sandbox/files_downloads**
  351. Allows read or write access to the user's "Downloads" folder. See `com.apple.security.files.downloads.read-write <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_files_downloads_read-write>`__.
  352. .. rst-class:: classref-item-separator
  353. ----
  354. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_movies:
  355. .. rst-class:: classref-property
  356. :ref:`int<class_int>` **codesign/entitlements/app_sandbox/files_movies**
  357. Allows read or write access to the user's "Movies" folder. See `com.apple.security.files.movies.read-write <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_assets_movies_read-write>`__.
  358. .. rst-class:: classref-item-separator
  359. ----
  360. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_music:
  361. .. rst-class:: classref-property
  362. :ref:`int<class_int>` **codesign/entitlements/app_sandbox/files_music**
  363. Allows read or write access to the user's "Music" folder. See `com.apple.security.files.music.read-write <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_assets_music_read-write>`__.
  364. .. rst-class:: classref-item-separator
  365. ----
  366. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_pictures:
  367. .. rst-class:: classref-property
  368. :ref:`int<class_int>` **codesign/entitlements/app_sandbox/files_pictures**
  369. Allows read or write access to the user's "Pictures" folder. See `com.apple.security.files.pictures.read-write <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_assets_pictures_read-write>`__.
  370. .. rst-class:: classref-item-separator
  371. ----
  372. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_user_selected:
  373. .. rst-class:: classref-property
  374. :ref:`int<class_int>` **codesign/entitlements/app_sandbox/files_user_selected**
  375. Allows read or write access to the locations the user has selected using a native file dialog. See `com.apple.security.files.user-selected.read-write <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_files_user-selected_read-write>`__.
  376. .. rst-class:: classref-item-separator
  377. ----
  378. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/helper_executables:
  379. .. rst-class:: classref-property
  380. :ref:`Array<class_Array>` **codesign/entitlements/app_sandbox/helper_executables**
  381. List of helper executables to embedded to the app bundle. Sandboxed app are limited to execute only these executable. See `Embedding a command-line tool in a sandboxed app <https://developer.apple.com/documentation/xcode/embedding-a-helper-tool-in-a-sandboxed-app>`__.
  382. .. rst-class:: classref-item-separator
  383. ----
  384. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/network_client:
  385. .. rst-class:: classref-property
  386. :ref:`bool<class_bool>` **codesign/entitlements/app_sandbox/network_client**
  387. Enable to allow app to establish outgoing network connections. See `com.apple.security.network.client <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_network_client>`__.
  388. .. rst-class:: classref-item-separator
  389. ----
  390. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/network_server:
  391. .. rst-class:: classref-property
  392. :ref:`bool<class_bool>` **codesign/entitlements/app_sandbox/network_server**
  393. Enable to allow app to listen for incoming network connections. See `com.apple.security.network.server <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_network_server>`__.
  394. .. rst-class:: classref-item-separator
  395. ----
  396. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/apple_events:
  397. .. rst-class:: classref-property
  398. :ref:`bool<class_bool>` **codesign/entitlements/apple_events**
  399. Enable to allow app to send Apple events to other apps. See `com.apple.security.automation.apple-events <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_automation_apple-events>`__.
  400. .. rst-class:: classref-item-separator
  401. ----
  402. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/audio_input:
  403. .. rst-class:: classref-property
  404. :ref:`bool<class_bool>` **codesign/entitlements/audio_input**
  405. Enable if you need to use the microphone or other audio input sources, if it's enabled you should also provide usage message in the ``privacy/microphone_usage_description`` option. See `com.apple.security.device.audio-input <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_device_audio-input>`__.
  406. .. rst-class:: classref-item-separator
  407. ----
  408. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/calendars:
  409. .. rst-class:: classref-property
  410. :ref:`bool<class_bool>` **codesign/entitlements/calendars**
  411. Enable to allow access to the user's calendar, if it's enabled you should also provide usage message in the ``privacy/calendar_usage_description`` option. See `com.apple.security.personal-information.calendars <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_personal-information_calendars>`__.
  412. .. rst-class:: classref-item-separator
  413. ----
  414. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/camera:
  415. .. rst-class:: classref-property
  416. :ref:`bool<class_bool>` **codesign/entitlements/camera**
  417. Enable if you need to use the camera, if it's enabled you should also provide usage message in the ``privacy/camera_usage_description`` option. See `com.apple.security.device.camera <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_device_camera>`__.
  418. .. rst-class:: classref-item-separator
  419. ----
  420. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/custom_file:
  421. .. rst-class:: classref-property
  422. :ref:`String<class_String>` **codesign/entitlements/custom_file**
  423. Custom entitlements ``.plist`` file, if specified the rest of entitlements in the export config are ignored.
  424. .. rst-class:: classref-item-separator
  425. ----
  426. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/debugging:
  427. .. rst-class:: classref-property
  428. :ref:`bool<class_bool>` **codesign/entitlements/debugging**
  429. You can temporarily enable this entitlement to use native debugger (GDB, LLDB) with the exported app. This entitlement should be disabled for production export. See `Embedding a command-line tool in a sandboxed app <https://developer.apple.com/documentation/xcode/embedding-a-helper-tool-in-a-sandboxed-app>`__.
  430. .. rst-class:: classref-item-separator
  431. ----
  432. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/disable_library_validation:
  433. .. rst-class:: classref-property
  434. :ref:`bool<class_bool>` **codesign/entitlements/disable_library_validation**
  435. Allows app to load arbitrary libraries and frameworks (not signed with the same Team ID as the main executable or by Apple). Enable it if you are using GDExtension add-ons or ad-hoc signing, or want to support user-provided external add-ons. See `com.apple.security.cs.disable-library-validation <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_cs_disable-library-validation>`__.
  436. .. rst-class:: classref-item-separator
  437. ----
  438. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/location:
  439. .. rst-class:: classref-property
  440. :ref:`bool<class_bool>` **codesign/entitlements/location**
  441. Enable if you need to use location information from Location Services, if it's enabled you should also provide usage message in the ``privacy/location_usage_description`` option. See `com.apple.security.personal-information.location <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_personal-information_location>`__.
  442. .. rst-class:: classref-item-separator
  443. ----
  444. .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/photos_library:
  445. .. rst-class:: classref-property
  446. :ref:`bool<class_bool>` **codesign/entitlements/photos_library**
  447. Enable to allow access to the user's Photos library, if it's enabled you should also provide usage message in the ``privacy/photos_library_usage_description`` option. See `com.apple.security.personal-information.photos-library <https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_personal-information_photos-library>`__.
  448. .. rst-class:: classref-item-separator
  449. ----
  450. .. _class_EditorExportPlatformMacOS_property_codesign/identity:
  451. .. rst-class:: classref-property
  452. :ref:`String<class_String>` **codesign/identity**
  453. The "Full Name", "Common Name" or SHA-1 hash of the signing identity used to sign ``.app`` bundle.
  454. .. rst-class:: classref-item-separator
  455. ----
  456. .. _class_EditorExportPlatformMacOS_property_codesign/installer_identity:
  457. .. rst-class:: classref-property
  458. :ref:`String<class_String>` **codesign/installer_identity**
  459. The "Full Name", "Common Name" or SHA-1 hash of the signing identity used to sign ``.pkg`` installer package for App Store distribution, use ``3rd Party Mac Developer Installer: Name.`` identity.
  460. .. rst-class:: classref-item-separator
  461. ----
  462. .. _class_EditorExportPlatformMacOS_property_codesign/provisioning_profile:
  463. .. rst-class:: classref-property
  464. :ref:`String<class_String>` **codesign/provisioning_profile**
  465. Provisioning profile file downloaded from Apple developer account dashboard. See `Edit, download, or delete provisioning profiles <https://developer.apple.com/help/account/manage-profiles/edit-download-or-delete-profiles>`__.
  466. Can be overridden with the environment variable ``GODOT_MACOS_CODESIGN_PROVISIONING_PROFILE``.
  467. .. rst-class:: classref-item-separator
  468. ----
  469. .. _class_EditorExportPlatformMacOS_property_custom_template/debug:
  470. .. rst-class:: classref-property
  471. :ref:`String<class_String>` **custom_template/debug**
  472. Path to the custom export template. If left empty, default template is used.
  473. .. rst-class:: classref-item-separator
  474. ----
  475. .. _class_EditorExportPlatformMacOS_property_custom_template/release:
  476. .. rst-class:: classref-property
  477. :ref:`String<class_String>` **custom_template/release**
  478. Path to the custom export template. If left empty, default template is used.
  479. .. rst-class:: classref-item-separator
  480. ----
  481. .. _class_EditorExportPlatformMacOS_property_debug/export_console_wrapper:
  482. .. rst-class:: classref-property
  483. :ref:`int<class_int>` **debug/export_console_wrapper**
  484. If enabled, a wrapper that can be used to run the application with console output is created alongside the exported application.
  485. .. rst-class:: classref-item-separator
  486. ----
  487. .. _class_EditorExportPlatformMacOS_property_display/high_res:
  488. .. rst-class:: classref-property
  489. :ref:`bool<class_bool>` **display/high_res**
  490. If ``true``, the application is rendered at native display resolution, otherwise it is always rendered at loHPI resolution and upscaled by OS when required.
  491. .. rst-class:: classref-item-separator
  492. ----
  493. .. _class_EditorExportPlatformMacOS_property_export/distribution_type:
  494. .. rst-class:: classref-property
  495. :ref:`int<class_int>` **export/distribution_type**
  496. Application distribution target.
  497. .. rst-class:: classref-item-separator
  498. ----
  499. .. _class_EditorExportPlatformMacOS_property_notarization/api_key:
  500. .. rst-class:: classref-property
  501. :ref:`String<class_String>` **notarization/api_key**
  502. Apple App Store Connect API issuer key file.
  503. Can be overridden with the environment variable ``GODOT_MACOS_NOTARIZATION_API_KEY``.
  504. .. rst-class:: classref-item-separator
  505. ----
  506. .. _class_EditorExportPlatformMacOS_property_notarization/api_key_id:
  507. .. rst-class:: classref-property
  508. :ref:`String<class_String>` **notarization/api_key_id**
  509. Apple App Store Connect API issuer key ID.
  510. Can be overridden with the environment variable ``GODOT_MACOS_NOTARIZATION_API_KEY_ID``.
  511. .. rst-class:: classref-item-separator
  512. ----
  513. .. _class_EditorExportPlatformMacOS_property_notarization/api_uuid:
  514. .. rst-class:: classref-property
  515. :ref:`String<class_String>` **notarization/api_uuid**
  516. Apple App Store Connect API issuer UUID.
  517. Can be overridden with the environment variable ``GODOT_MACOS_NOTARIZATION_API_UUID``.
  518. .. rst-class:: classref-item-separator
  519. ----
  520. .. _class_EditorExportPlatformMacOS_property_notarization/apple_id_name:
  521. .. rst-class:: classref-property
  522. :ref:`String<class_String>` **notarization/apple_id_name**
  523. Apple ID account name (email address).
  524. Can be overridden with the environment variable ``GODOT_MACOS_NOTARIZATION_APPLE_ID_NAME``.
  525. .. rst-class:: classref-item-separator
  526. ----
  527. .. _class_EditorExportPlatformMacOS_property_notarization/apple_id_password:
  528. .. rst-class:: classref-property
  529. :ref:`String<class_String>` **notarization/apple_id_password**
  530. Apple ID app-specific password.
  531. Can be overridden with the environment variable ``GODOT_MACOS_NOTARIZATION_APPLE_ID_PASSWORD``.
  532. .. rst-class:: classref-item-separator
  533. ----
  534. .. _class_EditorExportPlatformMacOS_property_notarization/notarization:
  535. .. rst-class:: classref-property
  536. :ref:`int<class_int>` **notarization/notarization**
  537. Tool to use for notarization.
  538. .. rst-class:: classref-item-separator
  539. ----
  540. .. _class_EditorExportPlatformMacOS_property_privacy/address_book_usage_description:
  541. .. rst-class:: classref-property
  542. :ref:`String<class_String>` **privacy/address_book_usage_description**
  543. A message displayed when requesting access to the user's contacts (in English).
  544. .. rst-class:: classref-item-separator
  545. ----
  546. .. _class_EditorExportPlatformMacOS_property_privacy/address_book_usage_description_localized:
  547. .. rst-class:: classref-property
  548. :ref:`Dictionary<class_Dictionary>` **privacy/address_book_usage_description_localized**
  549. A message displayed when requesting access to the user's contacts (localized).
  550. .. rst-class:: classref-item-separator
  551. ----
  552. .. _class_EditorExportPlatformMacOS_property_privacy/calendar_usage_description:
  553. .. rst-class:: classref-property
  554. :ref:`String<class_String>` **privacy/calendar_usage_description**
  555. A message displayed when requesting access to the user's calendar data (in English).
  556. .. rst-class:: classref-item-separator
  557. ----
  558. .. _class_EditorExportPlatformMacOS_property_privacy/calendar_usage_description_localized:
  559. .. rst-class:: classref-property
  560. :ref:`Dictionary<class_Dictionary>` **privacy/calendar_usage_description_localized**
  561. A message displayed when requesting access to the user's calendar data (localized).
  562. .. rst-class:: classref-item-separator
  563. ----
  564. .. _class_EditorExportPlatformMacOS_property_privacy/camera_usage_description:
  565. .. rst-class:: classref-property
  566. :ref:`String<class_String>` **privacy/camera_usage_description**
  567. A message displayed when requesting access to the device's camera (in English).
  568. .. rst-class:: classref-item-separator
  569. ----
  570. .. _class_EditorExportPlatformMacOS_property_privacy/camera_usage_description_localized:
  571. .. rst-class:: classref-property
  572. :ref:`Dictionary<class_Dictionary>` **privacy/camera_usage_description_localized**
  573. A message displayed when requesting access to the device's camera (localized).
  574. .. rst-class:: classref-item-separator
  575. ----
  576. .. _class_EditorExportPlatformMacOS_property_privacy/desktop_folder_usage_description:
  577. .. rst-class:: classref-property
  578. :ref:`String<class_String>` **privacy/desktop_folder_usage_description**
  579. A message displayed when requesting access to the user's "Desktop" folder (in English).
  580. .. rst-class:: classref-item-separator
  581. ----
  582. .. _class_EditorExportPlatformMacOS_property_privacy/desktop_folder_usage_description_localized:
  583. .. rst-class:: classref-property
  584. :ref:`Dictionary<class_Dictionary>` **privacy/desktop_folder_usage_description_localized**
  585. A message displayed when requesting access to the user's "Desktop" folder (localized).
  586. .. rst-class:: classref-item-separator
  587. ----
  588. .. _class_EditorExportPlatformMacOS_property_privacy/documents_folder_usage_description:
  589. .. rst-class:: classref-property
  590. :ref:`String<class_String>` **privacy/documents_folder_usage_description**
  591. A message displayed when requesting access to the user's "Documents" folder (in English).
  592. .. rst-class:: classref-item-separator
  593. ----
  594. .. _class_EditorExportPlatformMacOS_property_privacy/documents_folder_usage_description_localized:
  595. .. rst-class:: classref-property
  596. :ref:`Dictionary<class_Dictionary>` **privacy/documents_folder_usage_description_localized**
  597. A message displayed when requesting access to the user's "Documents" folder (localized).
  598. .. rst-class:: classref-item-separator
  599. ----
  600. .. _class_EditorExportPlatformMacOS_property_privacy/downloads_folder_usage_description:
  601. .. rst-class:: classref-property
  602. :ref:`String<class_String>` **privacy/downloads_folder_usage_description**
  603. A message displayed when requesting access to the user's "Downloads" folder (in English).
  604. .. rst-class:: classref-item-separator
  605. ----
  606. .. _class_EditorExportPlatformMacOS_property_privacy/downloads_folder_usage_description_localized:
  607. .. rst-class:: classref-property
  608. :ref:`Dictionary<class_Dictionary>` **privacy/downloads_folder_usage_description_localized**
  609. A message displayed when requesting access to the user's "Downloads" folder (localized).
  610. .. rst-class:: classref-item-separator
  611. ----
  612. .. _class_EditorExportPlatformMacOS_property_privacy/location_usage_description:
  613. .. rst-class:: classref-property
  614. :ref:`String<class_String>` **privacy/location_usage_description**
  615. A message displayed when requesting access to the user's location information (in English).
  616. .. rst-class:: classref-item-separator
  617. ----
  618. .. _class_EditorExportPlatformMacOS_property_privacy/location_usage_description_localized:
  619. .. rst-class:: classref-property
  620. :ref:`Dictionary<class_Dictionary>` **privacy/location_usage_description_localized**
  621. A message displayed when requesting access to the user's location information (localized).
  622. .. rst-class:: classref-item-separator
  623. ----
  624. .. _class_EditorExportPlatformMacOS_property_privacy/microphone_usage_description:
  625. .. rst-class:: classref-property
  626. :ref:`String<class_String>` **privacy/microphone_usage_description**
  627. A message displayed when requesting access to the device's microphone (in English).
  628. .. rst-class:: classref-item-separator
  629. ----
  630. .. _class_EditorExportPlatformMacOS_property_privacy/microphone_usage_description_localized:
  631. .. rst-class:: classref-property
  632. :ref:`Dictionary<class_Dictionary>` **privacy/microphone_usage_description_localized**
  633. A message displayed when requesting access to the device's microphone (localized).
  634. .. rst-class:: classref-item-separator
  635. ----
  636. .. _class_EditorExportPlatformMacOS_property_privacy/network_volumes_usage_description:
  637. .. rst-class:: classref-property
  638. :ref:`String<class_String>` **privacy/network_volumes_usage_description**
  639. A message displayed when requesting access to the user's network drives (in English).
  640. .. rst-class:: classref-item-separator
  641. ----
  642. .. _class_EditorExportPlatformMacOS_property_privacy/network_volumes_usage_description_localized:
  643. .. rst-class:: classref-property
  644. :ref:`Dictionary<class_Dictionary>` **privacy/network_volumes_usage_description_localized**
  645. A message displayed when requesting access to the user's network drives (localized).
  646. .. rst-class:: classref-item-separator
  647. ----
  648. .. _class_EditorExportPlatformMacOS_property_privacy/photos_library_usage_description:
  649. .. rst-class:: classref-property
  650. :ref:`String<class_String>` **privacy/photos_library_usage_description**
  651. A message displayed when requesting access to the user's photo library (in English).
  652. .. rst-class:: classref-item-separator
  653. ----
  654. .. _class_EditorExportPlatformMacOS_property_privacy/photos_library_usage_description_localized:
  655. .. rst-class:: classref-property
  656. :ref:`Dictionary<class_Dictionary>` **privacy/photos_library_usage_description_localized**
  657. A message displayed when requesting access to the user's photo library (localized).
  658. .. rst-class:: classref-item-separator
  659. ----
  660. .. _class_EditorExportPlatformMacOS_property_privacy/removable_volumes_usage_description:
  661. .. rst-class:: classref-property
  662. :ref:`String<class_String>` **privacy/removable_volumes_usage_description**
  663. A message displayed when requesting access to the user's removable drives (in English).
  664. .. rst-class:: classref-item-separator
  665. ----
  666. .. _class_EditorExportPlatformMacOS_property_privacy/removable_volumes_usage_description_localized:
  667. .. rst-class:: classref-property
  668. :ref:`Dictionary<class_Dictionary>` **privacy/removable_volumes_usage_description_localized**
  669. A message displayed when requesting access to the user's removable drives (localized).
  670. .. rst-class:: classref-item-separator
  671. ----
  672. .. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/cleanup_script:
  673. .. rst-class:: classref-property
  674. :ref:`String<class_String>` **ssh_remote_deploy/cleanup_script**
  675. Script code to execute on the remote host when app is finished.
  676. The following variables can be used in the script:
  677. - ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to.
  678. - ``{archive_name}`` - Name of the ZIP containing uploaded application.
  679. - ``{exe_name}`` - Name of application executable.
  680. - ``{cmd_args}`` - Array of the command line argument for the application.
  681. .. rst-class:: classref-item-separator
  682. ----
  683. .. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/enabled:
  684. .. rst-class:: classref-property
  685. :ref:`bool<class_bool>` **ssh_remote_deploy/enabled**
  686. Enables remote deploy using SSH/SCP.
  687. .. rst-class:: classref-item-separator
  688. ----
  689. .. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/extra_args_scp:
  690. .. rst-class:: classref-property
  691. :ref:`String<class_String>` **ssh_remote_deploy/extra_args_scp**
  692. Array of the additional command line arguments passed to the SCP.
  693. .. rst-class:: classref-item-separator
  694. ----
  695. .. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/extra_args_ssh:
  696. .. rst-class:: classref-property
  697. :ref:`String<class_String>` **ssh_remote_deploy/extra_args_ssh**
  698. Array of the additional command line arguments passed to the SSH.
  699. .. rst-class:: classref-item-separator
  700. ----
  701. .. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/host:
  702. .. rst-class:: classref-property
  703. :ref:`String<class_String>` **ssh_remote_deploy/host**
  704. Remote host SSH user name and address, in ``user@address`` format.
  705. .. rst-class:: classref-item-separator
  706. ----
  707. .. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/port:
  708. .. rst-class:: classref-property
  709. :ref:`String<class_String>` **ssh_remote_deploy/port**
  710. Remote host SSH port number.
  711. .. rst-class:: classref-item-separator
  712. ----
  713. .. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/run_script:
  714. .. rst-class:: classref-property
  715. :ref:`String<class_String>` **ssh_remote_deploy/run_script**
  716. Script code to execute on the remote host when running the app.
  717. The following variables can be used in the script:
  718. - ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to.
  719. - ``{archive_name}`` - Name of the ZIP containing uploaded application.
  720. - ``{exe_name}`` - Name of application executable.
  721. - ``{cmd_args}`` - Array of the command line argument for the application.
  722. .. rst-class:: classref-item-separator
  723. ----
  724. .. _class_EditorExportPlatformMacOS_property_xcode/platform_build:
  725. .. rst-class:: classref-property
  726. :ref:`String<class_String>` **xcode/platform_build**
  727. macOS build number used to build application executable.
  728. .. rst-class:: classref-item-separator
  729. ----
  730. .. _class_EditorExportPlatformMacOS_property_xcode/sdk_build:
  731. .. rst-class:: classref-property
  732. :ref:`String<class_String>` **xcode/sdk_build**
  733. macOS SDK build number used to build application executable.
  734. .. rst-class:: classref-item-separator
  735. ----
  736. .. _class_EditorExportPlatformMacOS_property_xcode/sdk_name:
  737. .. rst-class:: classref-property
  738. :ref:`String<class_String>` **xcode/sdk_name**
  739. macOS SDK name used to build application executable.
  740. .. rst-class:: classref-item-separator
  741. ----
  742. .. _class_EditorExportPlatformMacOS_property_xcode/sdk_version:
  743. .. rst-class:: classref-property
  744. :ref:`String<class_String>` **xcode/sdk_version**
  745. macOS SDK version used to build application executable in the ``major.minor`` format.
  746. .. rst-class:: classref-item-separator
  747. ----
  748. .. _class_EditorExportPlatformMacOS_property_xcode/xcode_build:
  749. .. rst-class:: classref-property
  750. :ref:`String<class_String>` **xcode/xcode_build**
  751. Xcode build number used to build application executable.
  752. .. rst-class:: classref-item-separator
  753. ----
  754. .. _class_EditorExportPlatformMacOS_property_xcode/xcode_version:
  755. .. rst-class:: classref-property
  756. :ref:`String<class_String>` **xcode/xcode_version**
  757. Xcode version used to build application executable.
  758. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  759. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  760. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  761. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  762. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  763. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  764. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`