class_editorexportplatformweb.rst 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  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/web/doc_classes/EditorExportPlatformWeb.xml.
  6. .. _class_EditorExportPlatformWeb:
  7. EditorExportPlatformWeb
  8. =======================
  9. **Inherits:** :ref:`EditorExportPlatform<class_EditorExportPlatform>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Exporter for the Web.
  11. .. rst-class:: classref-introduction-group
  12. Tutorials
  13. ---------
  14. - :doc:`Exporting for the Web <../tutorials/export/exporting_for_web>`
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`String<class_String>` | :ref:`custom_template/debug<class_EditorExportPlatformWeb_property_custom_template/debug>` |
  22. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`String<class_String>` | :ref:`custom_template/release<class_EditorExportPlatformWeb_property_custom_template/release>` |
  24. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`html/canvas_resize_policy<class_EditorExportPlatformWeb_property_html/canvas_resize_policy>` |
  26. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`String<class_String>` | :ref:`html/custom_html_shell<class_EditorExportPlatformWeb_property_html/custom_html_shell>` |
  28. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`bool<class_bool>` | :ref:`html/experimental_virtual_keyboard<class_EditorExportPlatformWeb_property_html/experimental_virtual_keyboard>` |
  30. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`bool<class_bool>` | :ref:`html/export_icon<class_EditorExportPlatformWeb_property_html/export_icon>` |
  32. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`bool<class_bool>` | :ref:`html/focus_canvas_on_start<class_EditorExportPlatformWeb_property_html/focus_canvas_on_start>` |
  34. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`String<class_String>` | :ref:`html/head_include<class_EditorExportPlatformWeb_property_html/head_include>` |
  36. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`Color<class_Color>` | :ref:`progressive_web_app/background_color<class_EditorExportPlatformWeb_property_progressive_web_app/background_color>` |
  38. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`int<class_int>` | :ref:`progressive_web_app/display<class_EditorExportPlatformWeb_property_progressive_web_app/display>` |
  40. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`bool<class_bool>` | :ref:`progressive_web_app/enabled<class_EditorExportPlatformWeb_property_progressive_web_app/enabled>` |
  42. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`String<class_String>` | :ref:`progressive_web_app/icon_144x144<class_EditorExportPlatformWeb_property_progressive_web_app/icon_144x144>` |
  44. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`String<class_String>` | :ref:`progressive_web_app/icon_180x180<class_EditorExportPlatformWeb_property_progressive_web_app/icon_180x180>` |
  46. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`String<class_String>` | :ref:`progressive_web_app/icon_512x512<class_EditorExportPlatformWeb_property_progressive_web_app/icon_512x512>` |
  48. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`String<class_String>` | :ref:`progressive_web_app/offline_page<class_EditorExportPlatformWeb_property_progressive_web_app/offline_page>` |
  50. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`int<class_int>` | :ref:`progressive_web_app/orientation<class_EditorExportPlatformWeb_property_progressive_web_app/orientation>` |
  52. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`bool<class_bool>` | :ref:`variant/extensions_support<class_EditorExportPlatformWeb_property_variant/extensions_support>` |
  54. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`bool<class_bool>` | :ref:`vram_texture_compression/for_desktop<class_EditorExportPlatformWeb_property_vram_texture_compression/for_desktop>` |
  56. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`bool<class_bool>` | :ref:`vram_texture_compression/for_mobile<class_EditorExportPlatformWeb_property_vram_texture_compression/for_mobile>` |
  58. +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  59. .. rst-class:: classref-section-separator
  60. ----
  61. .. rst-class:: classref-descriptions-group
  62. Property Descriptions
  63. ---------------------
  64. .. _class_EditorExportPlatformWeb_property_custom_template/debug:
  65. .. rst-class:: classref-property
  66. :ref:`String<class_String>` **custom_template/debug**
  67. Path to the custom export template. If left empty, default template is used.
  68. .. rst-class:: classref-item-separator
  69. ----
  70. .. _class_EditorExportPlatformWeb_property_custom_template/release:
  71. .. rst-class:: classref-property
  72. :ref:`String<class_String>` **custom_template/release**
  73. Path to the custom export template. If left empty, default template is used.
  74. .. rst-class:: classref-item-separator
  75. ----
  76. .. _class_EditorExportPlatformWeb_property_html/canvas_resize_policy:
  77. .. rst-class:: classref-property
  78. :ref:`int<class_int>` **html/canvas_resize_policy**
  79. The canvas resize policy determines how the canvas should be resized by Godot.
  80. .. rst-class:: classref-item-separator
  81. ----
  82. .. _class_EditorExportPlatformWeb_property_html/custom_html_shell:
  83. .. rst-class:: classref-property
  84. :ref:`String<class_String>` **html/custom_html_shell**
  85. .. container:: contribute
  86. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  87. .. rst-class:: classref-item-separator
  88. ----
  89. .. _class_EditorExportPlatformWeb_property_html/experimental_virtual_keyboard:
  90. .. rst-class:: classref-property
  91. :ref:`bool<class_bool>` **html/experimental_virtual_keyboard**
  92. .. container:: contribute
  93. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  94. .. rst-class:: classref-item-separator
  95. ----
  96. .. _class_EditorExportPlatformWeb_property_html/export_icon:
  97. .. rst-class:: classref-property
  98. :ref:`bool<class_bool>` **html/export_icon**
  99. .. container:: contribute
  100. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  101. .. rst-class:: classref-item-separator
  102. ----
  103. .. _class_EditorExportPlatformWeb_property_html/focus_canvas_on_start:
  104. .. rst-class:: classref-property
  105. :ref:`bool<class_bool>` **html/focus_canvas_on_start**
  106. .. container:: contribute
  107. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  108. .. rst-class:: classref-item-separator
  109. ----
  110. .. _class_EditorExportPlatformWeb_property_html/head_include:
  111. .. rst-class:: classref-property
  112. :ref:`String<class_String>` **html/head_include**
  113. .. container:: contribute
  114. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  115. .. rst-class:: classref-item-separator
  116. ----
  117. .. _class_EditorExportPlatformWeb_property_progressive_web_app/background_color:
  118. .. rst-class:: classref-property
  119. :ref:`Color<class_Color>` **progressive_web_app/background_color**
  120. .. container:: contribute
  121. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  122. .. rst-class:: classref-item-separator
  123. ----
  124. .. _class_EditorExportPlatformWeb_property_progressive_web_app/display:
  125. .. rst-class:: classref-property
  126. :ref:`int<class_int>` **progressive_web_app/display**
  127. .. container:: contribute
  128. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  129. .. rst-class:: classref-item-separator
  130. ----
  131. .. _class_EditorExportPlatformWeb_property_progressive_web_app/enabled:
  132. .. rst-class:: classref-property
  133. :ref:`bool<class_bool>` **progressive_web_app/enabled**
  134. .. container:: contribute
  135. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  136. .. rst-class:: classref-item-separator
  137. ----
  138. .. _class_EditorExportPlatformWeb_property_progressive_web_app/icon_144x144:
  139. .. rst-class:: classref-property
  140. :ref:`String<class_String>` **progressive_web_app/icon_144x144**
  141. .. container:: contribute
  142. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  143. .. rst-class:: classref-item-separator
  144. ----
  145. .. _class_EditorExportPlatformWeb_property_progressive_web_app/icon_180x180:
  146. .. rst-class:: classref-property
  147. :ref:`String<class_String>` **progressive_web_app/icon_180x180**
  148. .. container:: contribute
  149. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  150. .. rst-class:: classref-item-separator
  151. ----
  152. .. _class_EditorExportPlatformWeb_property_progressive_web_app/icon_512x512:
  153. .. rst-class:: classref-property
  154. :ref:`String<class_String>` **progressive_web_app/icon_512x512**
  155. .. container:: contribute
  156. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  157. .. rst-class:: classref-item-separator
  158. ----
  159. .. _class_EditorExportPlatformWeb_property_progressive_web_app/offline_page:
  160. .. rst-class:: classref-property
  161. :ref:`String<class_String>` **progressive_web_app/offline_page**
  162. .. container:: contribute
  163. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  164. .. rst-class:: classref-item-separator
  165. ----
  166. .. _class_EditorExportPlatformWeb_property_progressive_web_app/orientation:
  167. .. rst-class:: classref-property
  168. :ref:`int<class_int>` **progressive_web_app/orientation**
  169. .. container:: contribute
  170. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  171. .. rst-class:: classref-item-separator
  172. ----
  173. .. _class_EditorExportPlatformWeb_property_variant/extensions_support:
  174. .. rst-class:: classref-property
  175. :ref:`bool<class_bool>` **variant/extensions_support**
  176. .. container:: contribute
  177. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  178. .. rst-class:: classref-item-separator
  179. ----
  180. .. _class_EditorExportPlatformWeb_property_vram_texture_compression/for_desktop:
  181. .. rst-class:: classref-property
  182. :ref:`bool<class_bool>` **vram_texture_compression/for_desktop**
  183. .. container:: contribute
  184. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  185. .. rst-class:: classref-item-separator
  186. ----
  187. .. _class_EditorExportPlatformWeb_property_vram_texture_compression/for_mobile:
  188. .. rst-class:: classref-property
  189. :ref:`bool<class_bool>` **vram_texture_compression/for_mobile**
  190. .. container:: contribute
  191. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  192. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  193. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  194. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  195. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  196. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  197. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  198. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`