class_editorexportplatformmacos.rst 73 KB

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