class_editorexportplatformmacos.rst 75 KB

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