class_editorexportplatformwindows.rst 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617
  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/windows/doc_classes/EditorExportPlatformWindows.xml.
  6. .. _class_EditorExportPlatformWindows:
  7. EditorExportPlatformWindows
  8. ===========================
  9. **Inherits:** :ref:`EditorExportPlatformPC<class_EditorExportPlatformPC>` **<** :ref:`EditorExportPlatform<class_EditorExportPlatform>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Exporter for Windows.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. The Windows exporter customizes how a Windows build is handled. In the editor's "Export" window, it is created when adding a new "Windows" preset.
  15. .. rst-class:: classref-introduction-group
  16. Tutorials
  17. ---------
  18. - :doc:`Exporting for Windows <../tutorials/export/exporting_for_windows>`
  19. .. rst-class:: classref-reftable-group
  20. Properties
  21. ----------
  22. .. table::
  23. :widths: auto
  24. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`String<class_String>` | :ref:`application/company_name<class_EditorExportPlatformWindows_property_application/company_name>` |
  26. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`String<class_String>` | :ref:`application/console_wrapper_icon<class_EditorExportPlatformWindows_property_application/console_wrapper_icon>` |
  28. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`String<class_String>` | :ref:`application/copyright<class_EditorExportPlatformWindows_property_application/copyright>` |
  30. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`bool<class_bool>` | :ref:`application/d3d12_agility_sdk_multiarch<class_EditorExportPlatformWindows_property_application/d3d12_agility_sdk_multiarch>` |
  32. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`int<class_int>` | :ref:`application/export_angle<class_EditorExportPlatformWindows_property_application/export_angle>` |
  34. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`int<class_int>` | :ref:`application/export_d3d12<class_EditorExportPlatformWindows_property_application/export_d3d12>` |
  36. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`String<class_String>` | :ref:`application/file_description<class_EditorExportPlatformWindows_property_application/file_description>` |
  38. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`String<class_String>` | :ref:`application/file_version<class_EditorExportPlatformWindows_property_application/file_version>` |
  40. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`String<class_String>` | :ref:`application/icon<class_EditorExportPlatformWindows_property_application/icon>` |
  42. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`int<class_int>` | :ref:`application/icon_interpolation<class_EditorExportPlatformWindows_property_application/icon_interpolation>` |
  44. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`bool<class_bool>` | :ref:`application/modify_resources<class_EditorExportPlatformWindows_property_application/modify_resources>` |
  46. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`String<class_String>` | :ref:`application/product_name<class_EditorExportPlatformWindows_property_application/product_name>` |
  48. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`String<class_String>` | :ref:`application/product_version<class_EditorExportPlatformWindows_property_application/product_version>` |
  50. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`String<class_String>` | :ref:`application/trademarks<class_EditorExportPlatformWindows_property_application/trademarks>` |
  52. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`String<class_String>` | :ref:`binary_format/architecture<class_EditorExportPlatformWindows_property_binary_format/architecture>` |
  54. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`bool<class_bool>` | :ref:`binary_format/embed_pck<class_EditorExportPlatformWindows_property_binary_format/embed_pck>` |
  56. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`codesign/custom_options<class_EditorExportPlatformWindows_property_codesign/custom_options>` |
  58. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`String<class_String>` | :ref:`codesign/description<class_EditorExportPlatformWindows_property_codesign/description>` |
  60. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`int<class_int>` | :ref:`codesign/digest_algorithm<class_EditorExportPlatformWindows_property_codesign/digest_algorithm>` |
  62. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`bool<class_bool>` | :ref:`codesign/enable<class_EditorExportPlatformWindows_property_codesign/enable>` |
  64. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`String<class_String>` | :ref:`codesign/identity<class_EditorExportPlatformWindows_property_codesign/identity>` |
  66. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`int<class_int>` | :ref:`codesign/identity_type<class_EditorExportPlatformWindows_property_codesign/identity_type>` |
  68. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`String<class_String>` | :ref:`codesign/password<class_EditorExportPlatformWindows_property_codesign/password>` |
  70. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`bool<class_bool>` | :ref:`codesign/timestamp<class_EditorExportPlatformWindows_property_codesign/timestamp>` |
  72. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`String<class_String>` | :ref:`codesign/timestamp_server_url<class_EditorExportPlatformWindows_property_codesign/timestamp_server_url>` |
  74. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`String<class_String>` | :ref:`custom_template/debug<class_EditorExportPlatformWindows_property_custom_template/debug>` |
  76. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`String<class_String>` | :ref:`custom_template/release<class_EditorExportPlatformWindows_property_custom_template/release>` |
  78. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`int<class_int>` | :ref:`debug/export_console_wrapper<class_EditorExportPlatformWindows_property_debug/export_console_wrapper>` |
  80. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`bool<class_bool>` | :ref:`shader_baker/enabled<class_EditorExportPlatformWindows_property_shader_baker/enabled>` |
  82. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/cleanup_script<class_EditorExportPlatformWindows_property_ssh_remote_deploy/cleanup_script>` |
  84. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  85. | :ref:`bool<class_bool>` | :ref:`ssh_remote_deploy/enabled<class_EditorExportPlatformWindows_property_ssh_remote_deploy/enabled>` |
  86. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  87. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/extra_args_scp<class_EditorExportPlatformWindows_property_ssh_remote_deploy/extra_args_scp>` |
  88. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/extra_args_ssh<class_EditorExportPlatformWindows_property_ssh_remote_deploy/extra_args_ssh>` |
  90. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/host<class_EditorExportPlatformWindows_property_ssh_remote_deploy/host>` |
  92. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/port<class_EditorExportPlatformWindows_property_ssh_remote_deploy/port>` |
  94. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`String<class_String>` | :ref:`ssh_remote_deploy/run_script<class_EditorExportPlatformWindows_property_ssh_remote_deploy/run_script>` |
  96. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  97. | :ref:`bool<class_bool>` | :ref:`texture_format/etc2_astc<class_EditorExportPlatformWindows_property_texture_format/etc2_astc>` |
  98. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`bool<class_bool>` | :ref:`texture_format/s3tc_bptc<class_EditorExportPlatformWindows_property_texture_format/s3tc_bptc>` |
  100. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  101. .. rst-class:: classref-section-separator
  102. ----
  103. .. rst-class:: classref-descriptions-group
  104. Property Descriptions
  105. ---------------------
  106. .. _class_EditorExportPlatformWindows_property_application/company_name:
  107. .. rst-class:: classref-property
  108. :ref:`String<class_String>` **application/company_name** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/company_name>`
  109. Company that produced the application. Required. See `StringFileInfo <https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block>`__.
  110. .. rst-class:: classref-item-separator
  111. ----
  112. .. _class_EditorExportPlatformWindows_property_application/console_wrapper_icon:
  113. .. rst-class:: classref-property
  114. :ref:`String<class_String>` **application/console_wrapper_icon** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/console_wrapper_icon>`
  115. Console wrapper icon file. If left empty, it will fallback to :ref:`application/icon<class_EditorExportPlatformWindows_property_application/icon>`, then to :ref:`ProjectSettings.application/config/windows_native_icon<class_ProjectSettings_property_application/config/windows_native_icon>`, and lastly, :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`.
  116. .. rst-class:: classref-item-separator
  117. ----
  118. .. _class_EditorExportPlatformWindows_property_application/copyright:
  119. .. rst-class:: classref-property
  120. :ref:`String<class_String>` **application/copyright** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/copyright>`
  121. Copyright notice for the bundle visible to the user. Optional. See `StringFileInfo <https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block>`__.
  122. .. rst-class:: classref-item-separator
  123. ----
  124. .. _class_EditorExportPlatformWindows_property_application/d3d12_agility_sdk_multiarch:
  125. .. rst-class:: classref-property
  126. :ref:`bool<class_bool>` **application/d3d12_agility_sdk_multiarch** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/d3d12_agility_sdk_multiarch>`
  127. If ``true``, and :ref:`application/export_d3d12<class_EditorExportPlatformWindows_property_application/export_d3d12>` is set, the Agility SDK DLLs will be stored in arch-specific subdirectories.
  128. .. rst-class:: classref-item-separator
  129. ----
  130. .. _class_EditorExportPlatformWindows_property_application/export_angle:
  131. .. rst-class:: classref-property
  132. :ref:`int<class_int>` **application/export_angle** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/export_angle>`
  133. 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"``.
  134. .. rst-class:: classref-item-separator
  135. ----
  136. .. _class_EditorExportPlatformWindows_property_application/export_d3d12:
  137. .. rst-class:: classref-property
  138. :ref:`int<class_int>` **application/export_d3d12** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/export_d3d12>`
  139. If set to ``1``, the Direct3D 12 runtime libraries (Agility SDK, PIX) are exported with the exported application. If set to ``0``, Direct3D 12 libraries are exported only if :ref:`ProjectSettings.rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>` is set to ``"d3d12"``.
  140. .. rst-class:: classref-item-separator
  141. ----
  142. .. _class_EditorExportPlatformWindows_property_application/file_description:
  143. .. rst-class:: classref-property
  144. :ref:`String<class_String>` **application/file_description** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/file_description>`
  145. File description to be presented to users. Required. See `StringFileInfo <https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block>`__.
  146. .. rst-class:: classref-item-separator
  147. ----
  148. .. _class_EditorExportPlatformWindows_property_application/file_version:
  149. .. rst-class:: classref-property
  150. :ref:`String<class_String>` **application/file_version** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/file_version>`
  151. Version number of the file. Falls back to :ref:`ProjectSettings.application/config/version<class_ProjectSettings_property_application/config/version>` if left empty. See `StringFileInfo <https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block>`__.
  152. .. rst-class:: classref-item-separator
  153. ----
  154. .. _class_EditorExportPlatformWindows_property_application/icon:
  155. .. rst-class:: classref-property
  156. :ref:`String<class_String>` **application/icon** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/icon>`
  157. Application icon file. If left empty, it will fallback to :ref:`ProjectSettings.application/config/windows_native_icon<class_ProjectSettings_property_application/config/windows_native_icon>`, and then to :ref:`ProjectSettings.application/config/icon<class_ProjectSettings_property_application/config/icon>`.
  158. .. rst-class:: classref-item-separator
  159. ----
  160. .. _class_EditorExportPlatformWindows_property_application/icon_interpolation:
  161. .. rst-class:: classref-property
  162. :ref:`int<class_int>` **application/icon_interpolation** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/icon_interpolation>`
  163. Interpolation method used to resize application icon.
  164. .. rst-class:: classref-item-separator
  165. ----
  166. .. _class_EditorExportPlatformWindows_property_application/modify_resources:
  167. .. rst-class:: classref-property
  168. :ref:`bool<class_bool>` **application/modify_resources** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/modify_resources>`
  169. If enabled, icon and metadata of the exported executable is set according to the other ``application/*`` values.
  170. .. rst-class:: classref-item-separator
  171. ----
  172. .. _class_EditorExportPlatformWindows_property_application/product_name:
  173. .. rst-class:: classref-property
  174. :ref:`String<class_String>` **application/product_name** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/product_name>`
  175. Name of the application. Required. See `StringFileInfo <https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block>`__.
  176. .. rst-class:: classref-item-separator
  177. ----
  178. .. _class_EditorExportPlatformWindows_property_application/product_version:
  179. .. rst-class:: classref-property
  180. :ref:`String<class_String>` **application/product_version** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/product_version>`
  181. Application version visible to the user. Falls back to :ref:`ProjectSettings.application/config/version<class_ProjectSettings_property_application/config/version>` if left empty. See `StringFileInfo <https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block>`__.
  182. .. rst-class:: classref-item-separator
  183. ----
  184. .. _class_EditorExportPlatformWindows_property_application/trademarks:
  185. .. rst-class:: classref-property
  186. :ref:`String<class_String>` **application/trademarks** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_application/trademarks>`
  187. Trademarks and registered trademarks that apply to the file. Optional. See `StringFileInfo <https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block>`__.
  188. .. rst-class:: classref-item-separator
  189. ----
  190. .. _class_EditorExportPlatformWindows_property_binary_format/architecture:
  191. .. rst-class:: classref-property
  192. :ref:`String<class_String>` **binary_format/architecture** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_binary_format/architecture>`
  193. Application executable architecture.
  194. Supported architectures: ``x86_32``, ``x86_64``, and ``arm64``.
  195. .. rst-class:: classref-item-separator
  196. ----
  197. .. _class_EditorExportPlatformWindows_property_binary_format/embed_pck:
  198. .. rst-class:: classref-property
  199. :ref:`bool<class_bool>` **binary_format/embed_pck** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_binary_format/embed_pck>`
  200. If ``true``, project resources are embedded into the executable.
  201. .. rst-class:: classref-item-separator
  202. ----
  203. .. _class_EditorExportPlatformWindows_property_codesign/custom_options:
  204. .. rst-class:: classref-property
  205. :ref:`PackedStringArray<class_PackedStringArray>` **codesign/custom_options** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_codesign/custom_options>`
  206. Array of the additional command line arguments passed to the code signing tool. See `Sign Tool <https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe>`__.
  207. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray<class_PackedStringArray>` for more details.
  208. .. rst-class:: classref-item-separator
  209. ----
  210. .. _class_EditorExportPlatformWindows_property_codesign/description:
  211. .. rst-class:: classref-property
  212. :ref:`String<class_String>` **codesign/description** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_codesign/description>`
  213. Description of the signed content. See `Sign Tool <https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe>`__.
  214. .. rst-class:: classref-item-separator
  215. ----
  216. .. _class_EditorExportPlatformWindows_property_codesign/digest_algorithm:
  217. .. rst-class:: classref-property
  218. :ref:`int<class_int>` **codesign/digest_algorithm** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_codesign/digest_algorithm>`
  219. Digest algorithm to use for creating signature. See `Sign Tool <https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe>`__.
  220. .. rst-class:: classref-item-separator
  221. ----
  222. .. _class_EditorExportPlatformWindows_property_codesign/enable:
  223. .. rst-class:: classref-property
  224. :ref:`bool<class_bool>` **codesign/enable** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_codesign/enable>`
  225. If ``true``, executable signing is enabled.
  226. .. rst-class:: classref-item-separator
  227. ----
  228. .. _class_EditorExportPlatformWindows_property_codesign/identity:
  229. .. rst-class:: classref-property
  230. :ref:`String<class_String>` **codesign/identity** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_codesign/identity>`
  231. PKCS #12 certificate file used to sign executable or certificate SHA-1 hash (if :ref:`codesign/identity_type<class_EditorExportPlatformWindows_property_codesign/identity_type>` is set to "Use certificate store"). See `Sign Tool <https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe>`__.
  232. Can be overridden with the environment variable ``GODOT_WINDOWS_CODESIGN_IDENTITY``.
  233. .. rst-class:: classref-item-separator
  234. ----
  235. .. _class_EditorExportPlatformWindows_property_codesign/identity_type:
  236. .. rst-class:: classref-property
  237. :ref:`int<class_int>` **codesign/identity_type** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_codesign/identity_type>`
  238. Type of identity to use. See `Sign Tool <https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe>`__.
  239. Can be overridden with the environment variable ``GODOT_WINDOWS_CODESIGN_IDENTITY_TYPE``.
  240. .. rst-class:: classref-item-separator
  241. ----
  242. .. _class_EditorExportPlatformWindows_property_codesign/password:
  243. .. rst-class:: classref-property
  244. :ref:`String<class_String>` **codesign/password** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_codesign/password>`
  245. Password for the certificate file used to sign executable. See `Sign Tool <https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe>`__.
  246. Can be overridden with the environment variable ``GODOT_WINDOWS_CODESIGN_PASSWORD``.
  247. .. rst-class:: classref-item-separator
  248. ----
  249. .. _class_EditorExportPlatformWindows_property_codesign/timestamp:
  250. .. rst-class:: classref-property
  251. :ref:`bool<class_bool>` **codesign/timestamp** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_codesign/timestamp>`
  252. If ``true``, time-stamp is added to the signature. See `Sign Tool <https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe>`__.
  253. .. rst-class:: classref-item-separator
  254. ----
  255. .. _class_EditorExportPlatformWindows_property_codesign/timestamp_server_url:
  256. .. rst-class:: classref-property
  257. :ref:`String<class_String>` **codesign/timestamp_server_url** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_codesign/timestamp_server_url>`
  258. URL of the time stamp server. If left empty, the default server is used. See `Sign Tool <https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe>`__.
  259. .. rst-class:: classref-item-separator
  260. ----
  261. .. _class_EditorExportPlatformWindows_property_custom_template/debug:
  262. .. rst-class:: classref-property
  263. :ref:`String<class_String>` **custom_template/debug** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_custom_template/debug>`
  264. Path to the custom export template. If left empty, default template is used.
  265. .. rst-class:: classref-item-separator
  266. ----
  267. .. _class_EditorExportPlatformWindows_property_custom_template/release:
  268. .. rst-class:: classref-property
  269. :ref:`String<class_String>` **custom_template/release** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_custom_template/release>`
  270. Path to the custom export template. If left empty, default template is used.
  271. .. rst-class:: classref-item-separator
  272. ----
  273. .. _class_EditorExportPlatformWindows_property_debug/export_console_wrapper:
  274. .. rst-class:: classref-property
  275. :ref:`int<class_int>` **debug/export_console_wrapper** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_debug/export_console_wrapper>`
  276. If ``true``, a console wrapper executable is exported alongside the main executable, which allows running the project with enabled console output.
  277. .. rst-class:: classref-item-separator
  278. ----
  279. .. _class_EditorExportPlatformWindows_property_shader_baker/enabled:
  280. .. rst-class:: classref-property
  281. :ref:`bool<class_bool>` **shader_baker/enabled** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_shader_baker/enabled>`
  282. If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ and Mobile renderers.
  283. .. rst-class:: classref-item-separator
  284. ----
  285. .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/cleanup_script:
  286. .. rst-class:: classref-property
  287. :ref:`String<class_String>` **ssh_remote_deploy/cleanup_script** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_ssh_remote_deploy/cleanup_script>`
  288. Script code to execute on the remote host when app is finished.
  289. The following variables can be used in the script:
  290. - ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to.
  291. - ``{archive_name}`` - Name of the ZIP containing uploaded application.
  292. - ``{exe_name}`` - Name of application executable.
  293. - ``{cmd_args}`` - Array of the command line argument for the application.
  294. .. rst-class:: classref-item-separator
  295. ----
  296. .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/enabled:
  297. .. rst-class:: classref-property
  298. :ref:`bool<class_bool>` **ssh_remote_deploy/enabled** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_ssh_remote_deploy/enabled>`
  299. Enables remote deploy using SSH/SCP.
  300. .. rst-class:: classref-item-separator
  301. ----
  302. .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/extra_args_scp:
  303. .. rst-class:: classref-property
  304. :ref:`String<class_String>` **ssh_remote_deploy/extra_args_scp** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_ssh_remote_deploy/extra_args_scp>`
  305. Array of the additional command line arguments passed to the SCP.
  306. .. rst-class:: classref-item-separator
  307. ----
  308. .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/extra_args_ssh:
  309. .. rst-class:: classref-property
  310. :ref:`String<class_String>` **ssh_remote_deploy/extra_args_ssh** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_ssh_remote_deploy/extra_args_ssh>`
  311. Array of the additional command line arguments passed to the SSH.
  312. .. rst-class:: classref-item-separator
  313. ----
  314. .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/host:
  315. .. rst-class:: classref-property
  316. :ref:`String<class_String>` **ssh_remote_deploy/host** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_ssh_remote_deploy/host>`
  317. Remote host SSH user name and address, in ``user@address`` format.
  318. .. rst-class:: classref-item-separator
  319. ----
  320. .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/port:
  321. .. rst-class:: classref-property
  322. :ref:`String<class_String>` **ssh_remote_deploy/port** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_ssh_remote_deploy/port>`
  323. Remote host SSH port number.
  324. .. rst-class:: classref-item-separator
  325. ----
  326. .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/run_script:
  327. .. rst-class:: classref-property
  328. :ref:`String<class_String>` **ssh_remote_deploy/run_script** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_ssh_remote_deploy/run_script>`
  329. Script code to execute on the remote host when running the app.
  330. The following variables can be used in the script:
  331. - ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to.
  332. - ``{archive_name}`` - Name of the ZIP containing uploaded application.
  333. - ``{exe_name}`` - Name of application executable.
  334. - ``{cmd_args}`` - Array of the command line argument for the application.
  335. .. rst-class:: classref-item-separator
  336. ----
  337. .. _class_EditorExportPlatformWindows_property_texture_format/etc2_astc:
  338. .. rst-class:: classref-property
  339. :ref:`bool<class_bool>` **texture_format/etc2_astc** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_texture_format/etc2_astc>`
  340. If ``true``, project textures are exported in the ETC2/ASTC format.
  341. .. rst-class:: classref-item-separator
  342. ----
  343. .. _class_EditorExportPlatformWindows_property_texture_format/s3tc_bptc:
  344. .. rst-class:: classref-property
  345. :ref:`bool<class_bool>` **texture_format/s3tc_bptc** :ref:`๐Ÿ”—<class_EditorExportPlatformWindows_property_texture_format/s3tc_bptc>`
  346. If ``true``, project textures are exported in the S3TC/BPTC format.
  347. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  348. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  349. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  350. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  351. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  352. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  353. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  354. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  355. .. |void| replace:: :abbr:`void (No return value.)`