REFERENCE / GODOT GDEXTENSION
插件 API
查找公开属性、方法与信号,了解页面生命周期、对象绑定和渲染配置。
API 名称、签名和默认参数来自插件的 Godot 类文档,正文与搜索摘要提供中文说明。
UltralightAPI →
使用应用自行命名的 JavaScript 命名空间,持久注册业务接口。
CLASS / RefCountedUltralightBinding →
管理一个文档内可显式撤销的临时绑定。
CLASS / RefCountedUltralightBindingOptions →
配置绑定的成员范围、可写性和容器转换方式。
CLASS / RefCountedUltralightError →
保存脚本、加载、转换和生命周期错误的结构化信息。
CLASS / RefCountedUltralightFrameEvent →
提供只读的导航、框架和 URL 信息。
CLASS / UltralightViewUltralightInspector →
在 Godot 场景中显示 UltralightView 的内嵌开发者工具。
CLASS / UltralightJSValueUltralightJSArray →
保留当前文档中的实时 JavaScript Array。
CLASS / UltralightJSValueUltralightJSObject →
保留当前文档中的实时 JavaScript 普通对象。
CLASS / RefCountedUltralightJSValue →
以文档作用域句柄执行带错误检查的 JavaScript 操作。
CLASS / RefCountedUltralightResult →
明确区分成功值与结构化失败。
CLASS / ObjectUltralightSingleton →
管理共享的 Ultralight 渲染器及远程 Inspector。
CLASS / RefCountedUltralightTask →
只完成一次,并保留最终结果的异步操作。
CLASS / RefCountedUltralightUndefined →
在新接口中明确表示 JavaScript undefined。
CLASS / TextureRectUltralightView →
在 Godot TextureRect 中显示 HTML、CSS 和 JavaScript 页面。
页面生命周期
用 load_url/load_html 显式加载,等待主文档 dom_ready;frame_dom_ready 额外报告子框架信息。注册表在 window_ready 和页面脚本之前安装。导航、reload 和 rebuild 会使旧句柄与未完成任务失效。
数据与对象
容器默认双向共享,嵌套数据按需包装;evaluate_copy 和 snapshot 用于生成独立副本。C# 封装支持普通公开成员、Task/ValueTask 和集合适配,不要求 [Export]。read_only 限制写入,members 选择根对象成员。
渲染配置
accelerated 请求使用 RenderingDevice;is_accelerated() 返回实际后端。Compatibility 和 headless 回退到 CPU。修改 accelerated 或 transparent 后用 rebuild() 应用;此操作会替换文档。
Ultralight Free 版网页动画与重绘最高 60 FPS。max_render_fps = 0 仅取消单个 View 的限制,不会解除 SDK 版本上限。