Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
EditorExportPlatformWeb
繼承: EditorExportPlatform < RefCounted < Object
Web 匯出器。
說明
Web 匯出器能夠自訂 web 建置的處理方式。在編輯器的“匯出”視窗中,新增“Web”預設時會建立這個匯出器。
注意:Web 上的 Godot 是在一個 <canvas> 標籤中渲染的。這個畫布是作為程式的主 Window 使用的,但是一般沒有辦法手動調整位置和大小。
教學
屬性
屬性說明
String custom_template/debug 🔗
用於除錯建置的自訂匯出範本的檔案路徑。如果留空,則預設範本將被使用。
String custom_template/release 🔗
用於發佈版本的自訂匯出範本的檔案路徑。如果留空,則預設範本將被使用。
int html/canvas_resize_policy 🔗
決定 Godot 應如何調整畫布的大小。
None:畫布不會自動調整大小。
Project:畫布的大小由 ProjectSettings 決定。
Adaptive:畫布自動調整到盡可能覆蓋 Web 頁面的大小。
String html/custom_html_shell 🔗
包裹匯出後 Web 建置的自訂 HTML 頁面。留空時使用預設的 HTML 殼。
詳見教學《自訂 HTML5 殼》。
bool html/experimental_virtual_keyboard 🔗
實驗性: 此屬性可能在未來版本中變更或移除。
如果為 true,則將對虛擬鍵盤的支援嵌入到網頁中,在觸摸屏裝置上會在必要時顯示。
如果為 true,則專案圖示將用作該應用程式網頁的圖示。
bool html/focus_canvas_on_start 🔗
如果為 true,則瀏覽器視窗已經獲得焦點,且一旦載入應用程式時,畫布就會獲得焦點。
要在 <head> 中額外新增的 HTML 標籤,例如 <meta> 標籤。
注意:<title> 標籤無須自行新增,會根據專案名稱自動新增。
Color progressive_web_app/background_color 🔗
Web 應用程式後面使用的背景顏色。
int progressive_web_app/display 🔗
用於該漸進式 Web 應用程式的 顯示模式。不同的瀏覽器和平台的行為可能不同。
全螢幕:全螢幕顯示應用程式並隱藏所有瀏覽器的 UI 元素。
獨立:在單獨的視窗中顯示應用程式並隱藏所有瀏覽器的 UI 元素。
最小 UI:在單獨的視窗中顯示應用程式,並且僅顯示瀏覽器的 UI 元素以進行導航。
瀏覽器:將應用程式顯示為普通網頁。
bool progressive_web_app/enabled 🔗
如果為 true,則會將該 Web 建置設定為 漸進式網路應用程式(PWA)。
bool progressive_web_app/ensure_cross_origin_isolation_headers 🔗
啟用後,漸進式 Web 應用程式將確保每個請求都具有跨源隔離標頭(COEP/COOP)。
這可以簡化設定以服務匯出的遊戲。
String progressive_web_app/icon_144x144 🔗
該 Web 應用程式的最小圖示的檔案路徑。如果未定義,則預設為專案圖示。
注意:如果圖示不是 144×144,則它將自動調整大小以適應最終建置。
String progressive_web_app/icon_180x180 🔗
該 Web 應用程式的小圖示的檔案路徑。如果未定義,則預設為專案圖示。
注意:如果圖示不是 180×180,則它將自動調整大小以適應最終建置。
String progressive_web_app/icon_512x512 🔗
該 Web 應用程式的最小圖示的檔案路徑。如果未定義,則預設為專案圖示。
注意:如果圖示不是 512×512,則它將自動調整大小以適應最終建置。
String progressive_web_app/offline_page 🔗
如果托管該頁面的伺服器不可用,則顯示該頁面。該頁面儲存在用戶端的機器中。
int progressive_web_app/orientation 🔗
通過行動裝置執行 Web 應用程式時要使用的方向。
任意:不強制方向。
橫向:強制水平版面配置(寬度大於高度)。
縱向:強制垂直版面配置(高度大於寬度)。
int threads/emscripten_pool_size 🔗
Emscripten 在啟動時分配的執行緒數。較小的值將分配較少的執行緒,消耗較少的系統資源,但可能會面臨池中執行緒用完的風險,需要在執行時分配更多執行緒,可能導致死鎖。
注意:一些瀏覽器對可分配的執行緒數量有嚴格的限制,因此最好謹慎行事,保持較低的執行緒數。
覆蓋 WorkerThreadPool 的預設大小。該設定在 ProjectSettings.threading/worker_pool/max_threads 設為 -1(預設)時生效。該大小必須小於 threads/emscripten_pool_size,否則可能造成死鎖。
在使用執行緒時,該大小需足以容納相依性專用執行緒的特性,例如 ProjectSettings.physics/2d/run_on_separate_thread 和 ProjectSettings.rendering/driver/threads/thread_model。通常,建議確保此值至少為 4,並且至少比 threads/emscripten_pool_size 小 2 或 3。
bool variant/extensions_support 🔗
如果為 true,則啟用對該 Web 建置的 GDExtension 支援。
如果為 true,則匯出的遊戲將支援多執行緒。多執行緒支援要求網站支援“跨源隔離”,設定起來可能比較麻煩,並且可能會由於安全原因而受到限制(例如無法與第三方網站通信)。
如果為 false,則匯出的遊戲將不支援多執行緒。因此,遊戲會更容易出現效能和音訊問題,但只要求在 HTTPS 網站上執行。
bool vram_texture_compression/for_desktop 🔗
如果為 true,則允許通過 S3TC/BPTC 算法針對桌面最佳化紋理。
bool vram_texture_compression/for_mobile 🔗
如果為 true,則允許通過 ETC2/ASTC 算法針對行動裝置最佳化紋理。