概览
WebUIX for Unreal Engine
WebUIX 是自研的 HTML/CSS UI 渲染引擎,作为原生 UMG 插件运行在 Unreal Engine 中。无浏览器进程、无 JavaScript 引擎、无 CEF/Chromium — 用熟悉的 HTML/CSS 语法构建游戏 UI,通过 Blueprint 完成所有交互逻辑。
全平台支持
Win64、macOS、Linux、Android、iOS — 一套 HTML/CSS 在所有平台上渲染一致
高性能原生渲染
Direct RHI 渲染,无浏览器进程开销。支持跨帧缓存、脏区增量更新、独立 RT 拖拽预览
HTML/CSS 开发体验
Box model、Flexbox、过渡动画、CSS 滤镜、UI 音效 — 用 Web 前端技能构建游戏 UI
Blueprint 深度集成
事件桥(OnClick 调 UFUNCTION)、数据模型绑定、完整 DOM API、自定义组件系统
自定义 HTML 组件
在 Blueprint 中创建新 HTML 标签,定义自定义属性与事件。组件内 UFUNCTION 可直接在 HTML 中调用 — 类似 Web Components 开发模式
内置调试控制台
F8 打开 — 实时 DOM 树、元素选择器、样式计算面板、渲染统计、脏区可视化
手柄与控制器输入
自动输入设备检测(键鼠/触控/手柄),支持虚拟手柄光标(可为键鼠和手柄分别设置独立外观)与方向键/摇杆 UI 导航,nav-order 属性可显式控制导航顺序。
自定义 Emoji 字形
编辑器内置 Emoji Library 面板,可下载/导入/烘焙图标包,采用文件夹+SVG 格式,兼容 Twemoji/OpenMoji/Noto 目录约定;真彩色渲染,不受 CSS 文字颜色影响。
原生圆盘菜单
使用原生 radial-menu、radial-item 和 radial-center 元素构建动作圆盘,支持模板循环、百分比尺寸、空心中心、可配置边框与缝隙、图片、CSS hover 状态和蓝图事件。
浏览器风格边框
独立四边样式、椭圆与百分比圆角、轮廓、圆角阴影和九宫格边框图片,让装饰效果更贴近浏览器。
快速开始
WebUIXUserWidget,在同一个 Widget Blueprint 资产里完成 HTML、CSS、预览和蓝图逻辑。1. 创建资产
在 Content Browser 中使用 Add → WebUIX → Widget Blueprint / WebUIX User Widget。创建出的 Blueprint 父类是 UWebUIXUserWidget。
2. 内置编辑
打开资产后,直接在 WebUIX 编辑器布局里修改 HTML / CSS。普通界面不再需要先创建独立 WebUIX Widget 再手动绑定 HTML 文档。
3. 预览与调试
预览区使用同一套 WebUIX 渲染链路,适合检查布局、样式、资源、材质和组件状态。
4. 蓝图逻辑
HTML 里的 onclick、onchange 等事件会调用同名 Blueprint 函数或事件。需要操作元素时,用 Get Element By ID 或查询节点获取元素句柄。
最小 HTML 示例
<div class="demo-shell">
<h2>{{loc:demo.title|WebUIX Demo}}</h2>
<button id="switch-image" onclick="SwitchImage">
{{loc:demo.switch_image|Switch Image}}
</button>
<webuix-option-stepper
id="demo-quality-stepper"
label="{{loc:demo.graphics_quality|Graphics Quality}}"
options="GraphicsQualityOptions"
display-key="DisplayName"
value-key="Value"
data-webuix-bind-value="GraphicsQualityIndex"
onchange="OnGraphicsQualityChanged">
</webuix-option-stepper>
</div>
使用到游戏中
- 点击 Compile 和 Save。
- 运行时像普通 UMG 一样
Create Widget后Add to Viewport,也可以放进 HUD、其他 UMG 或 3D Widget 工作流。 - 多个界面需要共享同一套源码时,仍然可以引用独立 WebUIX HTML / CSS 资产;单个界面优先直接在
WebUIXUserWidget内完成。
编辑器工作流
内置代码编辑器
双击 HTML/CSS 资产打开,支持语法高亮、Ctrl+S 保存、Alt+Shift+F 格式化、自动补全(标签、属性、事件、CSS 属性、资源路径)。编辑器默认置顶。
外部文件同步与热重载
可将 HTML/CSS 资产链接到外部磁盘文件进行双向持久化同步:编辑外部文件后,改动会被自动检测并写回资产的 Source 属性(同时调用 MarkPackageDirty 将资产标记为脏),而不只是临时预览刷新,适合搭配习惯的外部编辑器做快速迭代。
资源选择器
CSS 中写 url(...) 时可打开资源选择器,按类型(图片、音频、字体等)筛选 UE 资产。音频资源支持预览播放。
诊断面板
编辑器底部状态栏显示诊断摘要(错误/警告),可跳转上一个/下一个诊断并复制诊断文本。
Loading Config
Loading Config 是 WebUIX 的加载界面配置资产,用来统一制作 Startup UI 和 Map Loading UI。它基于 UWebUIXLoadingScreenProfile,在一个 Blueprint 资产里保存页面、HTML、CSS、生命周期事件、跳过规则和进度状态。创建资产
在 Content Browser 中使用 Add → WebUIX → Loading Config 创建资产,然后打开它编辑启动页和地图加载页。
项目设置启用
在 Project Settings → Plugins → WebUIX → Loading Screen Config Asset 选择这个 Loading Config。
同一套编辑器布局
左侧资源树管理页面和生命周期,中间预览实时渲染,下方编辑 HTML / CSS,右侧编写蓝图逻辑。
运行时控制
可以由加载管理器、GameInstance 或 Loading Config 自身蓝图更新进度、状态和跳过逻辑。
页面配置
| 页面 | 用途 |
|---|---|
Startup Page | 游戏启动阶段显示,适合品牌、初始化、资源预热和首帧前遮罩。 |
Map Loading Page | 地图加载或关卡切换阶段显示,适合地图名、加载状态和提示文本。 |
模板变量
<div class="loading-screen startup-screen">
<div class="brand">WebUIX</div>
<div class="subtitle">{{LoadingStatus}}</div>
<div class="bar">
<div class="bar-fill" style="width: {{LoadingProgressPercent}}%;"></div>
</div>
</div>
Timing 配置
| 字段 | 说明 |
|---|---|
Minimum Display Time | 最短显示时间,避免加载界面一闪而过。 |
Maximum Display Time | 限制最长显示时间,防止异常加载永久卡住。 |
Fade In / Fade Out Duration | 控制加载界面的淡入淡出时间。 |
Auto Hide When Loading Completes | 加载完成后自动隐藏。 |
Block Until First Frame | 首帧准备完成前保持加载界面,减少黑屏或未初始化画面。 |
Hide Policy | 隐藏策略:手动、加载完成后、达到最短显示时间后。 |
Skip 配置
| 模式 | 说明 |
|---|---|
Disabled | 用户不能跳过。 |
Blueprint Only | 只能由蓝图调用跳过。 |
Any Key Or Click | 用户按键或点击即可请求跳过。 |
蓝图生命周期
在 Loading Config Blueprint 内实现这些事件和函数,可以控制开始显示、地图加载、加载完成、跳过请求、是否隐藏和是否允许跳过。
全局 Blueprint API
建议由加载管理器或 GameInstance 统一调用 WebUIX Set Loading Progress,页面只负责展示模板变量和响应生命周期事件。
编辑器界面
这些界面展示 WebUIX 的主要编辑体验:在 Unreal Editor 内同时处理 HTML/CSS、实时预览、Blueprint 逻辑、Loading Screen 配置、本地化文本和项目级设置。
- 变量列表会显示名称、类型和绑定状态,方便检查模板数据来源。
- Preview 面板用于快速查看 UI 布局,不需要离开 Widget Blueprint。
- HTML/CSS Source 与 Widget 资产绑定,适合直接编辑结构和样式。
- Blueprint Logic 与 WebUIX 事件、变量刷新和交互逻辑保持在同一个编辑器内。
- 顶部标签切换 Startup Screen 与 Map Loading 页面。
- Preview 支持常见分辨率和比例检查。
- HTML 模板可使用 LoadingProgressPercent、LoadingStatus 和 loc 本地化标记。
- 右侧 Blueprint Logic 负责加载状态、进度和生命周期事件。
- 模板中可直接写 loc key,并提供 fallback 文本。
- Demo 页面用于验证按钮、页面切换、图片切换和调试入口。
- External Text 按钮用于把文本资源同步到外部编辑流程。
- 右侧 Blueprint Graph 仍然负责 UI 事件和业务逻辑。
- Input Method 可启用 Native IME。
- Debug 与 Shortcuts 控制 Inspector 打包和快捷键。
- Loading Screen Config Asset 指定项目默认加载界面。
- Rendering Performance 与 Rendering Quality 用于调节帧率预热、文本对比度和 Gamma。
1.6.0 更新内容
WebUIX 1.6.0 新增原生圆盘菜单、更完整的浏览器风格边框支持、更快的增量更新,以及更稳定的变换 HUD 渲染。
原生圆盘菜单
新增 radial-menu、radial-item 和 radial-center 元素,支持循环、绑定、百分比尺寸、空心中心、可配置缝隙与边框、图片、CSS hover 状态、选择事件以及 hover/unhover 事件。
扩展 CSS 边框
支持独立四边样式、椭圆与百分比圆角、带偏移的轮廓、改进的圆角阴影和九宫格 border-image,语法更贴近浏览器。
运行时性能
相同模型值写入会保持空闲,局部样式/绘制变化避免不必要的整树工作,transform/opacity 动画会尽量走保留式合成路径。
编辑器与 HUD 稳定性
改进了嵌套变换、hover 缩放、命中测试、裁剪、全屏缩放、预览复用、滚动位置恢复、CSS 提示、检查器打包和蓝图刷新行为。
兼容性
Win64 包已验证支持 Unreal Engine 5.0 至 5.8。现有 Widget、HTML/CSS 资源、模板、绑定和蓝图事件属性保持兼容。
HTML/CSS 基础
支持的 HTML 标签
扩展元素:drag-area drag-cell
drag-item handle radio-group radio-option
checkbox-group checkbox-option dropdown
dropdown-option password modal modal-title
modal-footer tooltips tooltips-content animation-watch
CSS 属性速查
布局与尺寸
盒模型
文字
Flexbox
背景与渲染
单位与值
Pseudo-class 状态
扩展状态::selected :open
:dragging :valid :invalid :hot
:occupied。部分 pseudo-state 会同步为 CSS class(.selected .open
.disabled)。
资源引用
图片和音频通过 UE 资产路径引用:
<img src="/Game/UI/Icons/Sword.Sword" />
.icon { background-image: url("/Game/UI/Icons/Sword.Sword"); }
.banner { background: url(banner.png) center / cover no-repeat; }
散列图片文件(PNG、JPG)在 Cook 时嵌入到 UWebUIXHtmlDocument 的派生数据中。
CSS 滤镜
WebUIX 支持多种 CSS 滤镜效果,可用于 UI 动效、背景模糊和视觉氛围增强。
filter
filter 属性对元素及其子元素的渲染结果应用图形效果。
| 函数 | 说明 | 示例 |
|---|---|---|
blur() |
高斯模糊 | filter: blur(4dp); |
brightness() |
亮度调节(0=黑,1=原始,>1=更亮) | filter: brightness(1.2); |
contrast() |
对比度调节(0=灰,1=原始,>1=更强) | filter: contrast(1.15); |
saturate() |
饱和度调节(0=去色,1=原始,>1=更鲜艳) | filter: saturate(1.5); |
drop-shadow() |
投影(类似 box-shadow 但跟随轮廓) | filter: drop-shadow(0 4dp 8dp #00000066); |
.card {
filter: drop-shadow(0 10dp 24dp #00000066);
}
.card:hover {
filter: brightness(1.1) drop-shadow(0 14dp 32dp #00000088);
transition: filter 200ms;
}
.inactive {
filter: brightness(0.6) saturate(0.3);
}
backdrop-filter
backdrop-filter 对元素背后区域的内容应用滤镜(常用于毛玻璃效果)。
.glass-panel {
background: rgba(255,255,255,.12);
backdrop-filter: blur(16dp);
border: 1dp rgba(255,255,255,.2);
border-radius: 16dp;
}
.overlay {
backdrop-filter: blur(8dp) brightness(0.5);
}
backdrop-filter 会引入额外的 RHI 渲染通道(BackdropFilterPass)。大量使用可能增加 GPU 开销,建议在调试控制台的 Paint 面板中查看 BackdropFilterPassCount 统计。
filter 与动画
filter 属性支持 CSS transition 和 animation 平滑过渡:
.btn {
filter: brightness(1);
transition: filter 150ms ease;
}
.btn:hover { filter: brightness(1.15); }
.btn:active { filter: brightness(0.92); }
@keyframes pulse-glow {
0%, 100% { filter: drop-shadow(0 0 4dp #38bdf844); }
50% { filter: drop-shadow(0 0 16dp #38bdf8aa); }
}
.glow { animation: pulse-glow 2s ease-in-out infinite; }
UI 音效
WebUIX 支持通过 CSS 属性 background-sound 在元素交互(hover、active、focus)时自动播放 UE
音频资产(USoundBase)。无需编写 Blueprint 逻辑。
CSS 属性
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
background-sound |
URI | — | 指向 USoundBase 资产路径 |
background-sound-volume |
float | 1.0 |
音量乘数(>=0) |
background-sound-pitch |
float | 1.0 |
音高乘数(>=0.01) |
background-sound-cooldown |
time | 0 |
播放冷却时间,支持 s/ms 后缀 |
触发时机
音效在以下 pseudo-class 激活时自动播放:
:hover— 鼠标悬停时:active— 按下时(鼠标/触摸):focus— 获得焦点时(Tab 导航等)
使用示例
资产路径使用 asset:/// 前缀(编辑器资源选择器自动补全):
/* Hover: glass sound, 50ms cooldown */
.ui-hover-sound:hover {
background-sound: url("asset:///WebUIX/WebUIX/Sound/glass_001.glass_001");
background-sound-volume: 0.35;
background-sound-cooldown: 0.05s;
}
/* Click: crisp click sound, higher volume */
.ui-click-sound:active {
background-sound: url("asset:///WebUIX/WebUIX/Sound/click_003.click_003");
background-sound-volume: 0.55;
background-sound-cooldown: 0.05s;
}
/* Focus: focus feedback sound */
.ui-focus-sound:focus {
background-sound: url("asset:///WebUIX/WebUIX/Sound/close_002.close_002");
background-sound-volume: 0.28;
}
<button class="btn primary ui-hover-sound ui-click-sound ui-focus-sound">
Confirm
</button>
提示:音效资产通过软引用(TWeakObjectPtr)管理,随文档自动 Cook 到包中。在 CSS 编辑器中使用资源选择器筛选 Audio 类型即可快速插入资产路径。
动画与过渡
CSS Transitions
支持对所有可动画属性的平滑过渡。常用可动画属性:color background-color
opacity transform filter width height
margin padding。
.card {
transform: scale(1);
filter: brightness(1);
transition: transform 180ms ease, filter 150ms;
}
.card:hover { transform: scale(1.04); filter: brightness(1.1); }
@keyframes
@keyframes slide-in {
0% { transform: translateY(-24dp); opacity: 0; }
100% { transform: translateY(0); opacity: 1; }
}
.modal-open { animation: slide-in 200ms ease-out; }
@keyframes fade-pulse {
0%, 100% { opacity: 1; }
50% { opacity: 0.5; }
}
.loading { animation: fade-pulse 1.2s ease-in-out infinite; }
支持:timing-function、iteration-count、direction、fill-mode、delay、play-state。
animation-watch 元素
animation-watch 观察 CSS 动画状态并通过事件桥发送 JSON payload 给 Blueprint。详见扩展元素章节。
1.6 保留式动画路径
transform 和 opacity 动画可以更新保留式合成层,无需重建布局或重绘整个文档;嵌套变换 HUD 元素会保持稳定的几何与命中测试。
若要低成本切换,请保持元素挂载,只修改 show、class、opacity 或 transform;局部视觉变化不要替换整份 HTML。
自定义组件
WebUIX 允许在 Blueprint 中创建全新的 HTML 标签 — 不是简单模板,而是一个拥有完整生命周期的组件。内置的
drag-area、modal、dropdown 等扩展元素均以这种方式实现。
快速创建
- 创建 Blueprint,父类选择 UWebUIXComponent
- 在 Class Settings 中填写
TagName(如my-card) - 编写默认 HTML 模板和 CSS — 这构成组件内部结构
- 实现
Construct/Tick/Destruct事件,通过Dom操作内部 DOM
暴露属性与事件 — 点击"公开"即可
在 Blueprint 中编写 UFUNCTION(BlueprintCallable) 函数后,只需在函数上点击 公开到
HTML,该函数就会自动成为 HTML 中可用的 OnXxx 事件属性。同样,Blueprint 变量点击公开后,即可在 HTML 中作为自定义属性使用。
<!-- Exposed as event: bind directly in HTML -->
<my-card title="Sword" OnCardClicked="OnSwordPicked(id)" OnRarityChanged="OnRarityUpdate(rarity)"></my-card>
<!-- Exposed as attribute: pass values like native attributes -->
<my-card title="Sword of Light" badge="{{Model.NewItems}}" rarity="epic" locked="true">
<p>A legendary weapon.</p>
</my-card>
<!-- Exposed as function: call directly in templates -->
<span>{{UE::CallText(GetCardStatus)}}</span>
编辑器的 HTML 代码补全会自动列出所有已注册组件的自定义属性、事件和函数,无需手动查找。
注册组件
全局:添加到 Project Settings → WebUIX →
Components,所有文档可用。
文档级:添加到 UWebUIXHtmlDocument 的 Components 数组,仅该文档可用。
DOM API
Dom->GetElementById("my-id");
Dom->QuerySelector(".my-class");
Dom->SetAttribute("badge", "5");
Dom->ClassListAdd("highlight");
Dom->StyleSetProperty("color", "#ff0");
Dom->SetTextContent("Updated!");
Dom->AppendChild(newElement);
CSS 边框
WebUIX 1.6.0 将边框渲染进一步对齐浏览器 CSS 语义,包括独立四边、更多线型、椭圆圆角、轮廓和九宫格边框图片。
独立四边与线型
可使用 border、border-width/style/color,或 border-top/right/bottom/left 简写与长写。四边可混合宽度、线型和颜色,并按浏览器式角点归属绘制。
椭圆与百分比圆角
border-radius 支持一至四个角、斜杠分隔的水平/垂直半径、四角独立属性和百分比。
.panel {
border-radius: 24dp 12dp 32dp 8dp / 16dp 28dp 12dp 20dp;
}
.avatar {
border-radius: 50%;
}
轮廓与偏移
outline 绘制在边框外侧且不占布局空间;outline-offset 可将其向内或向外偏移。
.focused {
outline: 2dp dashed #67e8f9;
outline-offset: 6dp;
}
九宫格边框图片
border-image 支持 source、slice、width、outset、repeat、fill 和简写形式,可用于可缩放框体。
.frame {
border: 12dp solid transparent;
border-image: url("/Game/UI/Frame.Frame") 24 fill / 12dp / 0 stretch;
}
混合边框示例
每条边和每个角都可以独立配置;相邻边按确定的浏览器式归属衔接,不会改变声明的边框宽度。
.mixed {
border-top: 4dp solid #2563eb;
border-right: 6dp dashed #0d9488;
border-bottom: 7dp dotted #d97706;
border-left: 8dp double #7c3aed;
border-top-left-radius: 18dp 12dp;
border-top-right-radius: 8dp 20dp;
border-bottom-right-radius: 24dp 10dp;
border-bottom-left-radius: 12dp 24dp;
}
兼容性说明
优先使用标准浏览器语法。WebUIX 将布局尺寸与边框绘制分开处理,因此轮廓和装饰边框无需额外补偿缝隙。
数据绑定与模板
上下文变量 {{变量}}
从 Widget Blueprint 或 Bridge Target 的同名属性读取值。调用
NotifyContextChanged("VariableName") 刷新。
<span>{{PlayerName}}</span>
<div style="width: {{Percent}}%;">{{Score}}</div>
数据模型 {{Model.Key}}
通过 SetModelString/SetModelNumber/SetModelBool 写入,HTML 中用 {{Model.Key}} 读取。
Widget->SetModelString("PlayerName", "Alice");
Widget->SetModelNumber("Health", 85.0f);
Widget->SetModelBool("IsAlive", true);
Widget->NotifyContextChanged();
本地化 {{loc:key|fallback}}
<span>{{loc:ui.start_button|Start Game}}</span>
<span>{{loc:hud.health|Health}}: {{Model.Health}}</span>
运行时切换语言:Widget->SetCulture("zh-Hans"); Widget->RefreshLocalization();
UE 内置统计 {{UE::FPS}}
| Token | 说明 |
|---|---|
{{UE::FPS}} |
当前帧率 |
{{UE::FrameMs}} |
总帧时间 (ms) |
{{UE::UpdateMs}} |
DOM 更新时间 (ms) |
{{UE::RenderMs}} |
渲染时间 (ms) |
{{UE::RhiDraws}} |
RHI 绘制调用数 |
{{UE::WidgetWidth}} / {{UE::WidgetHeight}} |
控件显示尺寸 |
UE::CallText / UE::CallHtml
调用 UFUNCTION 并将返回值插入 HTML 中。CallText 插为纯文本,CallHtml 插为 HTML 片段。
<h2>{{UE::CallText(GetPanelTitle)}}</h2>
<span>{{UE::CallText(FormatScore, Value=Model.Score)}}</span>
<div html="UE::CallHtml(BuildInventoryRows)"></div>
模板指令
<!-- forEach loop -->
<template foreach="item in Model.Items">
<div class="item-row">{{item.Name}} × {{item.Count}}</div>
</template>
<!-- Conditional rendering -->
<template if="{{Model.IsLoggedIn}}">
<div class="welcome">Welcome, {{PlayerName}}!</div>
</template>
<template else>
<div class="login-prompt">Please log in.</div>
</template>
<!-- switch -->
<template switch="{{Model.Tab}}">
<template case="inventory"><div>Inventory</div></template>
<template case="shop"><div>Shop</div></template>
<template default><div>Unknown</div></template>
</template>
<!-- show visibility control -->
<div show="{{Model.HasBonus}}">Bonus Active!</div>
多语言与本地化
HTML 语法
所有可见文本都可以使用 {{loc:key|fallback}}。key 是稳定的翻译 ID;fallback 是翻译还不存在时使用的源文本。
<h2>{{loc:menu.title|Main Menu}}</h2>
<button onclick="StartGame">{{loc:menu.start|Start Game}}</button>
<span>{{loc:hud.health|Health}}: {{Model.Health}}</span>
属性与组件标签
本地化也可以写在属性值里,包括 label、placeholder、title、aria 文本以及 WebUIX 扩展元素配置。
<webuix-option-stepper
label="{{loc:settings.graphics_quality|Graphics Quality}}"
options="GraphicsQualityOptions"
display-key="DisplayName"
value-key="Value"
onchange="OnGraphicsQualityChanged">
</webuix-option-stepper>
<input placeholder="{{loc:login.name_placeholder|Player name}}" />
Key 命名
推荐使用按功能域划分的 key,这样布局变化时翻译仍然稳定。不要用行号或临时控件名作为 key。
| Key | 用途 |
|---|---|
menu.start | 主菜单标签和按钮。 |
hud.health | HUD 文本,例如生命值、分数、弹药或状态。 |
settings.graphics_quality | 设置面板标签和选项名。 |
login.name_placeholder | 输入框占位文本或提示文本。 |
收集与编译流程
- 在 WebUIX HTML 源码中新增或修改 {{loc:key|fallback}}。
- 针对目标 Engine 和 Project 运行本地化编译脚本。
- 需要人工校对中文时,编辑 Content/WebUIX/Localization/WebUIX/zh-Hans/WebUIX.po。
- 把更新后的 PO、archive、manifest 和 locres 一起提交,保证打包版本和编辑器显示一致。
Plugins\WebUIX\Scripts\Compile-Localization.ps1 -EngineRoot F:\UE_5.0 -ProjectPath F:\ue5\YourProject\YourProject.uproject
运行时切换语言
在 WebUIX widget 上调用 Set Culture 可以切换 UE culture 并重新加载本地化文本。如果 culture 已经由外部系统切换,只需要刷新当前文档文本时使用 Refresh Localization。
Set Culture: zh-Hans
Set Culture: en
Refresh Localization
打包检查清单
- 打包项目包含目标 culture,例如 en 或 zh-Hans。
- 游戏可切换到的每个 culture 都有对应的 WebUIX.locres。
- HTML fallback 可作为兜底文本,但正式文本应来自本地化资源。
常见问题
| 问题 | 处理方式 |
|---|---|
| 页面显示 fallback 文本。 | 确认 key 已进入 PO/archive,然后重新运行编译脚本生成 locres。 |
| 语言已切换但 UI 没刷新。 | 在 WebUIX widget 上调用 Set Culture,或在外部切换 culture 后调用 Refresh Localization。 |
| 编辑器正常,打包后不生效。 | 检查打包 culture,并确认生成的 WebUIX.locres 被包含进包内。 |
事件桥
通过 HTML 事件属性调用 Blueprint UFUNCTION,按函数名查找 Widget 或 Bridge Target。
支持的事件
| 事件 | 触发时机 |
|---|---|
OnClick |
鼠标/触摸点击释放 |
OnDblClick |
双击 |
OnInput |
输入值变化(每次按键) |
OnChange |
值提交(blur/Enter/松开) |
OnFocus |
获得焦点 |
OnBlur |
失去焦点 |
OnKeyDown / OnKeyUp |
键盘按下/释放 |
OnOpen / OnClose |
元素打开/关闭 |
OnDragstart / OnDrag / OnDragend |
拖拽开始/移动/结束 |
OnDragover / OnDragout / OnDragdrop |
拖拽悬停/离开/放下 |
OnAnimationStart / OnAnimationUpdate / OnAnimationEnd /
OnAnimationCancel |
动画生命周期 |
使用示例
<button OnClick="StartGame">Start</button>
<button OnClick="OpenSettings(panel='video')">Settings</button>
<input value="{{Model.SearchText}}" OnChange="OnSearchChanged(value)" />
<input value="{{Model.Name}}" OnInput="OnNameInput(value)" />
<div class="item-slot" OnClick="OnSlotClicked(id)" />
<drag-area OnDrop="OnItemDropped(event, id)" />
Bridge Object
创建 UWebUIXBridgeObject,设置 TargetObject,赋给 Widget 的 BridgeObject 属性。事件按名称路由到目标对象。
UMG 导航 (nav-order)
通过 nav-order 属性控制手柄/键盘导航顺序:
<button nav-order="10">First</button>
<button nav-order="20">Second</button>
<button nav-order="auto">Auto</button>
<div nav-order="none">Skipped</div>
动画监听
<animation-watch> 观察指定范围内的 CSS transition / animation
状态变化,并通过事件桥将包含动画名、进度、当前值等信息的 JSON payload 发送给 Blueprint。适合做连击动效、过场动画完成的回调等。
基本用法
<animation-watch id="hud-watch"
scope="subtree"
visible-only="true"
emit-update="true"
update-rate="8"
OnAnimationStart="OnHudAnimationStart"
OnAnimationUpdate="OnHudAnimationUpdate"
OnAnimationEnd="OnHudAnimationEnd"
OnAnimationCancel="OnHudAnimationCancel">
<div class="animated-card">Reward</div>
</animation-watch>
范围控制
scope 支持
self(仅自身)、children(直接子元素)、subtree(所有后代)。大量节点同时动效时优先缩小范围。
可见性过滤
visible-only="true"(默认)跳过 display:none / visibility:hidden 的 watcher 和目标。设为
false 可监听隐藏元素。
更新频率控制
emit-update="false" 只保留 start/end/cancel 事件;update-rate 限制
update 频率(Hz),0 表示不连续派发。
事件 Payload
JSON 包含
type、watchId、targetId、name、property、elapsed、duration、progress、currentValue
等字段。
拖拽系统
网格拖拽
<drag-area id="bag" columns="5" rows="4" count="13" gap="8dp"
drag-anchor="center" OnDragdrop="OnBagDrop(TargetId)">
<drag-cell class="slot">
<span>#{{dragCell::DisplayIndex}}</span>
<span>{{dragCell::DisplayCol}},{{dragCell::DisplayRow}}</span>
</drag-cell>
<drag-item id="sword" col="0" row="0" cols="2" rows="2"
OnDragstart="OnItemDragStart" OnDragend="OnItemDragEnd">
<b>2x2</b>
</drag-item>
</drag-area>
模板变量:{{dragCell::DisplayIndex}} {{dragArea::UsableCount}}
{{dragItem::PreviewValid}}。可通过 var-scope="Inventory" 重命名作用域。
自由拖拽(浮动面板)
<div id="panel" class="floating-panel">
<handle class="title-bar" move_target="panel" edge_margin="0dp">
Drag Panel
</handle>
<p>This panel can be moved by dragging the title bar.</p>
</div>
handle 元素通过 move_target 指定被拖拽的目标,edge_margin
限制边界。拖拽预览渲染在独立透明 RT 上,主页面纹理不会被修改。
拖拽状态 CSS
drag-cell.slot:hot { background: #38bdf833; }
drag-cell.slot:occupied { border-color: #f59e0b; }
drag-item.item:dragging { opacity: .72; transform: scale(1.04); }
drag-item.item:invalid { filter: drop-shadow(0 0 8dp #ef4444); }
表单控件
radio-group / radio-option
<radio-group value="comfortable" name="Density" OnChange="OnRadioChanged(value)">
<radio-option value="compact">Compact</radio-option>
<radio-option value="comfortable" selected>Comfortable</radio-option>
<radio-option value="debug">Debug</radio-option>
</radio-group>
checkbox-group / checkbox-option
<checkbox-group value="svg,animation" OnInput="OnFeaturesInput(value)">
<checkbox-option value="svg" selected>SVG</checkbox-option>
<checkbox-option value="animation" selected>Animation</checkbox-option>
<checkbox-option value="ime">IME</checkbox-option>
</checkbox-group>
多选值按 DOM 顺序保存为逗号分隔字符串。
dropdown / dropdown-option
支持单选和多选(multiple="true")。打开时菜单在内部 Popup Layer 绘制,DOM 和事件冒泡保持在 dropdown 内。
<dropdown value="rhi" placeholder="Select mode"
OnChange="OnDropdownChanged(value)">
<dropdown-option value="rhi" selected>RHI</dropdown-option>
<dropdown-option value="slate">Slate fallback</dropdown-option>
</dropdown>
Modal / Tooltips
modal
通过 value="true|false" 控制。modal-title 和 modal-footer
自定义标签;不写 footer 则自动生成按钮。
<button modal-action="open" modal-target="settings-modal">Open</button>
<modal id="settings-modal" value="{{SettingsModalOpen}}"
width="420dp" mask="true" close-on-click-modal="true"
close-on-press-escape="true" lock-scroll="true"
OnChange="OnSettingsModalChanged(value)">
<modal-title>Settings</modal-title>
<modal-footer>
<button modal-action="cancel">Cancel</button>
<button modal-action="confirm">Confirm</button>
</modal-footer>
</modal>
tooltips
<tooltips placement="top" effect="dark">
<button>Hover me</button>
<tooltips-content>
<b>Tip title</b>
<p>Explain this setting.</p>
</tooltips-content>
</tooltips>
Password
password
内部管理原生 password/text 输入和眼睛切换按钮。支持 visible="true|false"
show-toggle="true|false" disabled。
<password value="" placeholder="Access code"
name="AccessCode" OnInput="OnAccessCodeInput(value)" />
手柄与控制器输入
Project Settings 与自动检测
手柄输入系统受 Project Settings 中的 bEnableWebUIXGamepadInputSystem 总开关控制(默认开启);bAutoSwitchInputModeByDevice(默认开启)让插件根据最近一次输入事件的设备类型(键鼠/触控/手柄)自动切换当前输入模式,无需手动调用 Enter Gamepad Input Mode / Enter Mouse & Keyboard Input Mode。方向导航按键(上下左右)默认映射到手柄 D-Pad,二维导航摇杆默认使用左摇杆。
[/Script/WebUIX.WebUIXSettings]
bEnableWebUIXGamepadInputSystem=True
bAutoSwitchInputModeByDevice=True
; GamepadInput defaults (mirrors stock UE gamepad feel):
; ConfirmKey=Gamepad_FaceButton_Bottom, CancelKey=Gamepad_FaceButton_Right
; DirectionalNavStick=Gamepad_Left2D
; NavUpKey=Gamepad_DPad_Up, NavDownKey=Gamepad_DPad_Down
; NavLeftKey=Gamepad_DPad_Left, NavRightKey=Gamepad_DPad_Right
虚拟光标与 UWebUIXGamepadCursorLibrary
手柄模式下会显示一个由摇杆驱动的虚拟光标,行为与鼠标光标一致(可以点击、拖拽、悬停触发 CSS :hover)。UWebUIXGamepadCursorLibrary 蓝图函数库提供获取/覆盖当前输入设备、获取/覆盖导航配置,以及分别为键鼠光标和手柄光标设置独立外观(内置样式或自定义贴图+热点)的静态函数,具体函数签名见下方 Blueprint API 参考。
全局按键监听事件
OnAnyKeyDown / OnAnyKeyUp 是声明在 UWebUIXElementExtension(进而被 WebUIX User Widget / Widget 继承)上的被动监听委托,键盘、鼠标和手柄输入都会触发,且不会消费事件(不影响 HTML 元素自身的正常事件处理),常用来做全局按键提示/重映射 UI。OnInputDeviceChanged 会在自动检测到输入设备切换时触发,附带新的设备类型和(如果是手柄)具体型号名称。
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FWebUIXKeyEventDelegate, FKeyEvent, KeyEvent);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FWebUIXInputDeviceChangedDelegate, EWebUIXInputDeviceType, DeviceType, FName, GamepadModel);
// UWebUIXElementExtension / UWebUIXUserWidget / UWebUIXWidget:
UPROPERTY(BlueprintAssignable) FWebUIXKeyEventDelegate OnAnyKeyDown;
UPROPERTY(BlueprintAssignable) FWebUIXKeyEventDelegate OnAnyKeyUp;
UPROPERTY(BlueprintAssignable) FWebUIXInputDeviceChangedDelegate OnInputDeviceChanged;
nav-order 属性
在 HTML 元素上添加 nav-order 属性可以显式声明该元素在方向键/摇杆 UI 导航中的顺序,插件会按 nav-order 数值升序在可聚焦元素之间移动焦点。
<div class="menu">
<button nav-order="0" OnClick="OnResume">Resume</button>
<button nav-order="1" OnClick="OnSettings">Settings</button>
<button nav-order="2" OnClick="OnQuit">Quit</button>
</div>
UWebUIXNavigationStack
一个可选的页面栈管理工具(纯 UObject,非 Widget),提供 PushWidget / PopWidget / ClearWidgets / GetActiveWidget / NumWidgets,用于管理多层全屏页面(如主菜单→设置→图形选项)的入栈/出栈与激活/挂起状态,只有栈顶页面会参与手柄回退焦点(Activate)。因为是普通 UObject,需要用 UPROPERTY 持有它以防止被垃圾回收。
自定义 Emoji 字形
图标包格式
每个 emoji 图标包是一个文件夹,内含按十六进制 Unicode codepoint 命名的 SVG 文件(如 1f600.svg),多 codepoint 组合用短横线连接。这个目录结构与 Twemoji、OpenMoji、Noto Emoji 等主流开源图标集完全一致,可以零转换直接导入使用。
twemoji-common/
1f600.svg
1f602.svg
1f44d.svg
1f680.svg
Emoji Library 编辑器面板
编辑器工具栏内置 Emoji Library 面板,可以直接输入 URL 下载单个图标包(Download)、从磁盘导入已有的文件夹(Import Folder...)、导出一份示例包(Save Example Pack...)、管理已导入的图标包列表并移除(Remove),以及将当前图标包烘焙成运行时可用的图集资源(Bake For Shipping)。插件本身不内置任何 emoji 美术资源,需要自行下载或导入图标包。
真彩色渲染
自定义 emoji 字形在图集阶段直接光栅化写入真彩色 BGRA 像素,渲染时不会被当作"仅透明度"的普通文字字形处理,因此不受 CSS 文字颜色(color 属性)影响,能保留图标本身的原始配色。
渲染管线
WebUIX 使用保留渲染架构,每帧仅重新绘制发生变化的区域。
HTML + CSS -> DOM -> Style Cascade -> Layout -> Display List -> RHI Render Target -> Slate Present
瓦片绘制缓存
页面分为瓦片,稳定区域不重绘。仅脏瓦片被标记并重新光栅化。
Last-Frame-Wins
高频交互采用 latest-frame-wins 策略:旧视觉帧可以丢弃,最终状态保持准确。
独立拖拽预览
拖拽预览渲染在独立透明 RT 上 — 主页面纹理在拖拽过程中不会被修改。
避免不必要的 DOM 变更
优先使用 StyleSetProperty、ClassListAdd/Remove/Toggle、SetModelNumber + NotifyContextChanged 而非结构性 DOM 变更。
1.6 增量更新
无变化写入
重复写入相同模型值不会唤醒帧调度器,也不会安排重新布局。
定向失效
局部文本、属性、class、style 和模板变化会尽量只失效最小子树,而不是重建整个文档。
保留式合成
当变化不需要布局时,transform 和 opacity 更新会复用保留的显示记录与合成层。
稳定循环子项
在 for 列表中使用稳定 key,使未变化节点、组件实例和圆盘子项可跨更新复用。
Widget 组件池
UWebUIXWidgetPoolComponent 管理 Widget 实例池,实现即时的页面切换。池中的 Widget 在隐藏/显示周期中保留 DOM 状态、滚动位置和输入焦点。
使用方式
// C++
PoolComponent->ShowWebUIXWidget(MyWidgetClass, ViewportZOrder);
PoolComponent->HideWebUIXWidget(MyWidgetClass);
// Calling Show again reuses the same instance — no recreation
Blueprint 中对应节点:Show WebUIX Widget → Hide WebUIX Widget →
Show WebUIX Widget(复用实例)。
启动预热
UWebUIXStartupWarmupSubsystem 在游戏启动时自动扫描已 Cook 的 Widget Blueprint,预加载文档和资源。首次打开 UI 零延迟。
配置条件
- Widget Blueprint 父类必须是 UWebUIXUserWidget。
- 设置
bWarmupOnGameStart = true。 - 必须设置
DocumentAsset。
预热模式
| 模式 | 说明 |
|---|---|
DocumentCacheOnly |
异步后台预加载文档和 Cooked 资源(推荐) |
PrecreateHiddenWidget |
创建 Widget、以 Collapsed 状态加入视口、调用 PrewarmDocument()。之后用 ShowPrewarmedWidget() 立即显示。 |
Cook 预处理
UWebUIXHtmlDocument 在保存/Cook 时生成预计算数据,运行时直接使用,无需文件 I/O 或重新解析。
预计算内容
| 数据 | 说明 |
|---|---|
ResolvedHtmlBundle |
合并后的 HTML + 链接的 CSS |
CookedDomNodes |
预解析的 DOM 树 |
CookedStyleSheet |
已解析的样式表 |
CookedImageResources |
压缩后的图片字节(PNG/JPG) |
ReferencedAssets |
文档引用的所有 UE 资产(图片、音频等软引用) |
修改 HTML/CSS 源码后调用 UWebUIXHtmlDocument::RefreshDerivedData() 更新资产派生信息。
调试控制台
内置调试工具,Editor/PIE 下可用。焦点落在 WebUIX 画面后按 F8 打开或关闭。
元素选择器
使用 Pick 图标从渲染画面选择元素。Pick 模式只做 hit-test,不触发真实交互。
DOM 树
左侧显示实际渲染树(包括 WebUIX 生成的 non-DOM 节点如 selectvalue、selectarrow 等)。VSCode 风格语法配色,Ctrl+C 复制节点文本。
右侧 Tabs
Styles、Computed、Layout、Attributes、Events、Bindings — 支持右键横向拖动。
Paint 调试
Layout tab 显示 display item、paint chunk、dirty pixel 统计。选中元素可查看 paint order、bounds、cache 状态。
事件模拟
Events tab 提供 Hover/Unhover/Focus/Blur/Click 按钮。Pick 模式不触发控件行为,需用这些按钮模拟。
绑定检查
Bindings tab 列出事件属性和已实现 Blueprint 函数,支持 Jump 跳转和 Copy 复制。

性能统计与调试
GetLastRenderStats()
查看 RhiDrawCallCount、RhiBatchCount、RhiTextureUploadCount、BackdropFilterPassCount、FilterCompositePassCount 等约 90 个统计字段。
GetLastEventDebugInfo()
查看最近一次事件桥调用,排查 HTML 事件名、参数、目标对象或 missing function warning。
编辑器诊断
HTML/CSS 编辑器底部状态栏显示诊断摘要,可跳转上一个/下一个诊断并复制诊断文本。
性能建议
高频输入/hover/scroll 尽量 trigger render-only 刷新。列表批量更新优先 class、attribute 或 DataModel 批处理。
Blueprint API
Blueprint API
蓝图 API
每个条目都按实际 Blueprint 节点展示 C++ 名称、返回值、参数、用途和典型场景。点击“复制节点”可把可粘贴的 Blueprint 节点文本写入剪贴板。
预热文档
设置语言
刷新本地化
按 ID 获取元素
查询选择器
验证元素句柄
设置文本内容
设置属性
读取属性
设置样式属性
切换 Class
设置模型字符串
参考速查
集中列出 WebUIX 常用标签、事件属性、CSS 属性和状态选择器,方便快速查找。
事件属性
CSS 属性速查
布局
盒模型
文字
效果
音效
背景
Flexbox
模板
输入与 IME
Windows IME 通过 UE 文本输入接口接入。OnInput 实时同步、OnChange
提交语义、OnTextInput 底层字符流(中文输入不要只依赖它)。
WebUIX 1.6 新增速查
完整语法、事件参数、尺寸行为和示例请参阅 CSS 边框与圆盘菜单章节。
项目设置
通过 Project Settings → Plugins → WebUIX 访问(UWebUIXSettings)。
| Setting | 默认 | 说明 |
|---|---|---|
TargetFrameRate |
60 | WebUIX 控件最大渲染帧率 |
bEnableExperimentalNativeIme |
false | 启用原生 Windows IME(实验性) |
bPackageWebUIXInspectorInRuntime |
false | 打包时包含调试控制台(Editor/PIE 无需开启,直接按 F8) |
bAutoPrewarmDocument |
true | 首次加载时自动预热文档 |
TextContrast |
1.0 | 文字渲染对比度乘数 |
TextGamma |
1.0 | 文字渲染伽马 |
bEnableSubpixelText |
true | 子像素字体渲染 |
ViewportCullingPaddingPx |
8 | 视口裁剪额外像素 |
DocumentRoot |
— | 外置 HTML 文件根目录 |
Components |
— | 全局注册的自定义组件类列表 |
已知限制
- 支持平台:Win64、macOS、Linux、Android、iOS。
- WebUIX 是自研 HTML/CSS 渲染器,不是 Chromium 浏览器;不执行 JavaScript,不加载任意网页。
- 不支持
<video>、<audio>、<canvas>、<iframe>。 - 不支持 CSS 自定义属性(
var(--...))— 使用模板绑定系统替代。 - 不支持浏览器 API(
window、document、fetch、localStorage等)。 - IME 原生输入法(Windows)为实验性功能,其他平台使用回退模式。
- 无远程 URL 支持 — 所有资产必须来自 UE 资产系统或项目本地文件路径。