class_editorexportplatformweb.rst 14 KB

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