Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
- 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
- EditorExportPlatformAndroid
- EditorExportPlatformExtension
- EditorExportPlatformIOS
- EditorExportPlatformMacOS
- EditorExportPlatformPC (2)
- EditorExportPlatformWeb
Table of contents
-
var custom_template/debug: String -
var custom_template/release: String -
var html/canvas_resize_policy: int -
var html/custom_html_shell: String -
var html/experimental_virtual_keyboard: bool -
var html/export_icon: bool -
var html/focus_canvas_on_start: bool -
var html/head_include: String -
var progressive_web_app/background_color: Color -
var progressive_web_app/display: int -
var progressive_web_app/enabled: bool -
var progressive_web_app/ensure_cross_origin_isolation_headers: bool -
var progressive_web_app/icon_144x144: String -
var progressive_web_app/icon_180x180: String -
var progressive_web_app/icon_512x512: String -
var progressive_web_app/offline_page: String -
var progressive_web_app/orientation: int -
var variant/extensions_support: bool -
var variant/thread_support: bool -
var vram_texture_compression/for_desktop: bool -
var vram_texture_compression/for_mobile: bool
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 tag, as it is automatically included based on the project's name.
var progressive_web_app/background_color: Color#
The background color used behind the web application.
var progressive_web_app/display: int#
The display mode to use for this progressive web application. Different browsers and platforms may not behave the same.
- Fullscreen: Displays the app in fullscreen and hides all of the browser's UI elements.
- Standalone: Displays the app in a separate window and hides all of the browser's UI elements.
- Minimal UI: Displays the app in a separate window and only shows the browser's UI elements for navigation.
- Browser: Displays the app as a normal web page.
var progressive_web_app/enabled: bool#
If true, turns this web build into a progressive web application (PWA).
var progressive_web_app/ensure_cross_origin_isolation_headers: bool#
When enabled, the progressive web app will make sure that each request has cross-origin isolation headers (COEP/COOP).
This can simplify the setup to serve the exported game.
var progressive_web_app/icon_144x144: String#
File path to the smallest icon for this web application. If not defined, defaults to the project icon.
Note: If the icon is not 144×144, it will be automatically resized for the final build.
var progressive_web_app/icon_180x180: String#
File path to the small icon for this web application. If not defined, defaults to the project icon.
Note: If the icon is not 180×180, it will be automatically resized for the final build.
var progressive_web_app/icon_512x512: String#
File path to the largest icon for this web application. If not defined, defaults to the project icon.
Note: If the icon is not 512×512, it will be automatically resized for the final build.
var progressive_web_app/offline_page: String#
The page to display, should the server hosting the page not be available. This page is saved in the client's machine.
var progressive_web_app/orientation: int#
The orientation to use when the web application is run through a mobile device.
- Any: No orientation is forced.
- Landscape: Forces a horizontal layout (wider than it is taller).
- Portrait: Forces a vertical layout (taller than it is wider).
var variant/extensions_support: bool#
If true enables GDExtension support for this web build.
var variant/thread_support: bool#
If true, the exported game will support threads. It requires a "cross-origin isolated" website, which may be difficult to set up and is limited for security reasons (such as not being able to communicate with third-party websites).
If false, 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.
var vram_texture_compression/for_desktop: bool#
If true, allows textures to be optimized for desktop through the S3TC/BPTC algorithm.
var vram_texture_compression/for_mobile: bool#
If true allows textures to be optimized for mobile through the ETC2/ASTC algorithm.
Methods #