Inheritance #

RefCounted

- AESContext
- AStar2D
- AStar3D
- AStarGrid2D
- AudioEffectInstance (1)
- AudioSample
- AudioSamplePlayback
- AudioStreamPlayback (5)
- CameraFeed
- CharFXTransform
- ConfigFile
- Crypto
- DTLSServer
- DirAccess
- ENetConnection
- EditorContextMenuPlugin
- EditorDebuggerPlugin
- EditorDebuggerSession
- EditorExportPlatform (6)
- EditorExportPlugin
- EditorExportPreset
- EditorFeatureProfile
- EditorFileSystemImportFormatSupportQuery
- EditorInspectorPlugin
- EditorResourceConversionPlugin
- EditorResourcePreviewGenerator
- EditorResourceTooltipPlugin
- EditorSceneFormatImporter (4)
- EditorScenePostImport
- EditorScenePostImportPlugin
- EditorScript
- EditorTranslationParserPlugin
- EncodedObjectAsID
- EngineProfiler
- Expression
- FileAccess
- GLTFObjectModelProperty
- HMACContext
- HTTPClient
- HashingContext
- ImageFormatLoader (1)
- JavaClass
- JavaObject
- JavaScriptObject
- KinematicCollision2D
- KinematicCollision3D
- Lightmapper (1)
- MeshConvexDecompositionSettings
- MeshDataTool
- MultiplayerAPI (2)
- Mutex
- NavigationPathQueryParameters2D
- NavigationPathQueryParameters3D
- NavigationPathQueryResult2D
- NavigationPathQueryResult3D
- Node3DGizmo (1)
- OggPacketSequencePlayback
- OpenXRAPIExtension
- PCKPacker
- PackedDataContainerRef
- PacketPeer (8)
- PhysicsPointQueryParameters2D
- PhysicsPointQueryParameters3D
- PhysicsRayQueryParameters2D
- PhysicsRayQueryParameters3D
- PhysicsShapeQueryParameters2D
- PhysicsShapeQueryParameters3D
- PhysicsTestMotionParameters2D
- PhysicsTestMotionParameters3D
- PhysicsTestMotionResult2D
- PhysicsTestMotionResult3D
- RDAttachmentFormat
- RDFramebufferPass
- RDPipelineColorBlendState
- RDPipelineColorBlendStateAttachment
- RDPipelineDepthStencilState
- RDPipelineMultisampleState
- RDPipelineRasterizationState
- RDPipelineSpecializationConstant
- RDSamplerState
- RDShaderSource
- RDTextureFormat
- RDTextureView
- RDUniform
- RDVertexAttribute
- RandomNumberGenerator
- RegEx
- RegExMatch
- RenderSceneBuffers (2)
- RenderSceneBuffersConfiguration
- Resource (103)
- ResourceFormatLoader
- ResourceFormatSaver
- ResourceImporter (16)
- SceneState
- SceneTreeTimer
- Semaphore
- SkinReference
- StreamPeer (5)
- SurfaceTool
- TCPServer
- TLSOptions
- TextLine
- TextParagraph
- TextServer (1)
- Thread
- TranslationDomain
- TriangleMesh
- Tween
- Tweener (5)
- UDPServer
- UPNP
- UPNPDevice
- WeakRef
- WebRTCPeerConnection (1)
- XMLParser
- XRInterface (4)
- XRPose
- XRTracker (2)
- ZIPPacker
- ZIPReader
EditorExportPlatformWeb
Table of contents

EditorExportPlatformWeb #

is_refcounted, is_instantiable, editor, not_builtin_classes

Exporter for the Web.

The Web exporter customizes how a web build is handled. In the editor's "Export" window, it is created when adding a new "Web" preset.

Note: Godot on Web is rendered inside a tag. Normally, the canvas cannot be positioned or resized manually, but otherwise acts as the main Window of the application.

Members #

var custom_template/debug: String#

File path to the custom export template used for debug builds. If left empty, the default template is used.

var custom_template/release: String#

File path to the custom export template used for release builds. If left empty, the default template is used.

var html/canvas_resize_policy: int#

Determines how the canvas should be resized by Godot.

- None: The canvas is not automatically resized.

- Project: The size of the canvas is dependent on the ProjectSettings.

- Adaptive: The canvas is automatically resized to fit as much of the web page as possible.

var html/custom_html_shell: String#

The custom HTML page that wraps the exported web build. If left empty, the default HTML shell is used.

For more information, see the Customizing HTML5 Shell tutorial.

var html/experimental_virtual_keyboard: bool#

If true, embeds support for a virtual keyboard into the web page, which is shown when necessary on touchscreen devices.

var html/export_icon: bool#

If true, the project icon will be used as the favicon for this application's web page.

var html/focus_canvas_on_start: bool#

If true, the canvas will be focused as soon as the application is loaded, if the browser window is already in focus.

var html/head_include: String#

Additional HTML tags to include inside the , such as tags.

Note: You do not need to add a </code> tag, as it is automatically included based on the project's name.</p><h3 id="progressive_web_app/background_color"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> progressive_web_app</span><span class="token operator">/</span><span class="">background_color</span><span class="token punctuation">:</span><span class=""> Color</span></code></span><a href="#progressive_web_app/background_color" class="anchor">#</a></h3><p>The background color used behind the web application.</p><h3 id="progressive_web_app/display"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> progressive_web_app</span><span class="token operator">/</span><span class="">display</span><span class="token punctuation">:</span><span class=""> int</span></code></span><a href="#progressive_web_app/display" class="anchor">#</a></h3><p>The <a href=https://developer.mozilla.org/en-US/docs/Web/Manifest/display/>display mode</a> to use for this progressive web application. Different browsers and platforms may not behave the same.</p><p>- <b>Fullscreen:</b> Displays the app in fullscreen and hides all of the browser's UI elements.</p><p>- <b>Standalone:</b> Displays the app in a separate window and hides all of the browser's UI elements.</p><p>- <b>Minimal UI:</b> Displays the app in a separate window and only shows the browser's UI elements for navigation.</p><p>- <b>Browser:</b> Displays the app as a normal web page.</p><h3 id="progressive_web_app/enabled"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> progressive_web_app</span><span class="token operator">/</span><span class="">enabled</span><span class="token punctuation">:</span><span class=""> bool</span></code></span><a href="#progressive_web_app/enabled" class="anchor">#</a></h3><p>If <code>true</code>, turns this web build into a <a href=https://en.wikipedia.org/wiki/Progressive_web_app>progressive web application</a> (PWA).</p><h3 id="progressive_web_app/ensure_cross_origin_isolation_headers"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> progressive_web_app</span><span class="token operator">/</span><span class="">ensure_cross_origin_isolation_headers</span><span class="token punctuation">:</span><span class=""> bool</span></code></span><a href="#progressive_web_app/ensure_cross_origin_isolation_headers" class="anchor">#</a></h3><p>When enabled, the progressive web app will make sure that each request has cross-origin isolation headers (COEP/COOP).</p><p>This can simplify the setup to serve the exported game.</p><h3 id="progressive_web_app/icon_144x144"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> progressive_web_app</span><span class="token operator">/</span><span class="">icon_144x144</span><span class="token punctuation">:</span><span class=""> String</span></code></span><a href="#progressive_web_app/icon_144x144" class="anchor">#</a></h3><p>File path to the smallest icon for this web application. If not defined, defaults to the project icon.</p><p><b>Note:</b> If the icon is not 144×144, it will be automatically resized for the final build.</p><h3 id="progressive_web_app/icon_180x180"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> progressive_web_app</span><span class="token operator">/</span><span class="">icon_180x180</span><span class="token punctuation">:</span><span class=""> String</span></code></span><a href="#progressive_web_app/icon_180x180" class="anchor">#</a></h3><p>File path to the small icon for this web application. If not defined, defaults to the project icon.</p><p><b>Note:</b> If the icon is not 180×180, it will be automatically resized for the final build.</p><h3 id="progressive_web_app/icon_512x512"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> progressive_web_app</span><span class="token operator">/</span><span class="">icon_512x512</span><span class="token punctuation">:</span><span class=""> String</span></code></span><a href="#progressive_web_app/icon_512x512" class="anchor">#</a></h3><p>File path to the largest icon for this web application. If not defined, defaults to the project icon.</p><p><b>Note:</b> If the icon is not 512×512, it will be automatically resized for the final build.</p><h3 id="progressive_web_app/offline_page"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> progressive_web_app</span><span class="token operator">/</span><span class="">offline_page</span><span class="token punctuation">:</span><span class=""> String</span></code></span><a href="#progressive_web_app/offline_page" class="anchor">#</a></h3><p>The page to display, should the server hosting the page not be available. This page is saved in the client's machine.</p><h3 id="progressive_web_app/orientation"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> progressive_web_app</span><span class="token operator">/</span><span class="">orientation</span><span class="token punctuation">:</span><span class=""> int</span></code></span><a href="#progressive_web_app/orientation" class="anchor">#</a></h3><p>The orientation to use when the web application is run through a mobile device.</p><p>- <b>Any:</b> No orientation is forced.</p><p>- <b>Landscape:</b> Forces a horizontal layout (wider than it is taller).</p><p>- <b>Portrait:</b> Forces a vertical layout (taller than it is wider).</p><h3 id="variant/extensions_support"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> variant</span><span class="token operator">/</span><span class="">extensions_support</span><span class="token punctuation">:</span><span class=""> bool</span></code></span><a href="#variant/extensions_support" class="anchor">#</a></h3><p>If <code>true</code> enables <a href="/classes/GDExtension">GDExtension</a> support for this web build.</p><h3 id="variant/thread_support"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> variant</span><span class="token operator">/</span><span class="">thread_support</span><span class="token punctuation">:</span><span class=""> bool</span></code></span><a href="#variant/thread_support" class="anchor">#</a></h3><p>If <code>true</code>, the exported game will support threads. It requires <a href=https://web.dev/articles/coop-coep>a "cross-origin isolated" website</a>, which may be difficult to set up and is limited for security reasons (such as not being able to communicate with third-party websites).</p><p>If <code>false</code>, the exported game will not support threads. As a result, it is more prone to performance and audio issues, but will only require to be run on an HTTPS website.</p><h3 id="vram_texture_compression/for_desktop"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> vram_texture_compression</span><span class="token operator">/</span><span class="">for_desktop</span><span class="token punctuation">:</span><span class=""> bool</span></code></span><a href="#vram_texture_compression/for_desktop" class="anchor">#</a></h3><p>If <code>true</code>, allows textures to be optimized for desktop through the S3TC/BPTC algorithm.</p><h3 id="vram_texture_compression/for_mobile"><span class="prismjs language-gdscript"><code style="white-space:pre" class="language-gdscript"><span class="token keyword">var</span><span class=""> vram_texture_compression</span><span class="token operator">/</span><span class="">for_mobile</span><span class="token punctuation">:</span><span class=""> bool</span></code></span><a href="#vram_texture_compression/for_mobile" class="anchor">#</a></h3><p>If <code>true</code> allows textures to be optimized for mobile through the ETC2/ASTC algorithm.</p> </p> <h2 id="Methods"> Methods <a href="#Methods">#</a> </h2> <p> </p> <h2 id="Annotations"> Annotations <a href="#Annotations">#</a> </h2> <h2 id="Constants"> Constants <a href="#Constants">#</a> </h2> <h2 id="Constructors"> Constructors <a href="#Constructors">#</a> </h2> <h2 id="Enums"> Enums <a href="#Enums">#</a> </h2> <h2 id="Operators"> Operators <a href="#Operators">#</a> </h2> <h2 id="Signals"> Signals <a href="#Signals">#</a> </h2> <h2 id="Theme_Items"> Theme Items <a href="#Theme_Items">#</a> </h2> <h2 id="Tutorials"> Tutorials <a href="#Tutorials">#</a> </h2> </div> </div> </main> <footer class="footer"></footer> <script type="text/javascript"> window.addEventListener('DOMContentLoaded', (event) => { if (location.hash) { setTimeout(() => { const temp = location.hash.replaceAll('@', '\\@') document.querySelector(temp)?.scrollIntoView() }, 0) } }) </script> </body></html>