API 参考
正在准备搜索索引…

受检查的 Rml::Factory 实例化、解析和缓存操作。

解析同步执行,并从流当前位置读取。正常调用原生实例器和翻译器。 回调重入时拒绝解析及缓存变更。关闭运行时会使返回的原生持有者失效。 未解析到规则时样式表返回 null;语法诊断后可能返回部分规则。

源码与继承
成员目录23

方法

方法

  • 调用 ClearStyleSheetCache;仍被持有的容器保持有效。

    返回值

    void
    源码与继承
  • 读取精确原生注册;未知标签回退到 "*"。

    参数

    tag
    string

    精确查找键;与注册不同,此处不转为小写。

    返回值

    唯一实例器包装;回退实例器不存在时为 null。

    源码与继承
  • 复制 GetStructuralDataViewAttributeNames 的结果。

    返回值

    string[]

    独立数组,按原生集合顺序包含完整 "data-" 名称。

    源码与继承
  • 调用 InstanceContext,不进入 Core 注册表。

    参数

    name
    string

    传给选定原生分配器的精确名称。

    manager

    原生上下文借用的活跃渲染管理器。

    handler

    借用原生文本输入处理器,或 null。

    返回值

    null | Context

    自有上下文;分配器拒绝创建时为 null。

    保留原生默认尺寸和密度。布局或渲染前调用 setDimensions。 子节点保活持有者;remove 释放此上下文,不移除同名已注册上下文。

    源码与继承
  • 调用 InstanceDataController,返回实际原生持有者。

    参数

    name
    string

    精确已注册控制器类型。

    element

    活跃请求元素。

    返回值

    自有控制器或 null;Initialize 会挂载原生监听器。

    源码与继承
  • 调用 InstanceDataView,返回真实自有原生视图。

    参数

    name
    string

    已注册的原生视图类型。

    element

    活跃请求元素。

    返回值

    null | DataView

    自有视图或 null;手动使用不会注册原生调度。

    源码与继承
  • 解析自有文档,不将其插入上下文。

    参数

    context

    文档借用的原生上下文。

    stream

    从当前位置读取的已打开流。

    documentBaseTag
    string

    已注册的原生文档实例器及标签。

    返回值

    null | Document

    游离文档;原生创建失败时为 null。

    使用 InstanceDocumentStream,包含流来源 URL 及原生文档头处理。 不派发上下文加载通知。文档持有整棵树,子节点使其保活。 移除上下文或关闭时先销毁此树再释放资源。宿主流异常会传播; 原生语法诊断可能按 RmlUi 解析结果返回部分文档。

    源码与继承
  • 调用 InstanceElement,返回节点不会自动挂到父节点。

    参数

    parent
    null | Element

    传给原生实例器的父节点;根节点使用 null。

    instancer
    string

    已注册实例器名称;"*" 提供回退实例器。

    tag
    string

    实际标签,与实例器名称相互独立。

    attributes
    Record<string, VariantValue> = {}

    由原生 Factory 设置的自有 Variant 属性。

    返回值

    null | Element

    保留原生子类型的自有游离元素;失败时为 null。

    源码与继承
  • 调用 InstanceElementStream,追加解析得到的子节点。

    参数

    parent

    接收元素;拒绝上下文根节点。

    stream

    已打开的原生流,使用自身来源 URL。

    返回值

    boolean

    上游结果;宿主读取错误会抛出异常。RmlUi 6.3 解析后返回 true, 因此语法诊断可能留下部分子节点。

    源码与继承
  • 翻译、解码文本,并将原生文本或 RML 元素追加到父节点。

    参数

    parent

    接收解析子节点的元素。

    text
    string

    UTF-8 文本、RML 实体或 RML 标记。

    返回值

    boolean

    原生解析结果;纯空白不会添加子节点。

    源码与继承
  • 调用 InstanceEvent,返回尚未派发的自有事件。

    参数

    target

    活跃目标元素。

    id
    number

    已注册的原生事件编号。

    type
    string

    原生事件类型。

    parameters
    Readonly<Record<string, VariantValue>>

    有类型的参数字典。

    interruptible
    boolean

    原生传播能否停止。

    返回值

    null | RmlEvent

    自有事件;拒绝时为 null。

    源码与继承
  • 调用 Factory::InstanceEventListener,不挂载返回结果。

    参数

    value
    string

    确切的内联属性值。

    element

    活跃请求元素。

    返回值

    尚未挂载的监听器;禁用或拒绝时为 null。

    源码与继承
  • 使用无前缀类型名查询 IsStructuralDataView。

    参数

    name
    string

    精确类型名,如 "for"。

    返回值

    boolean

    原生解析器是否将此数据视图视为结构视图。

    源码与继承
  • 对应 RegisterDataControllerInstancer;保留首次注册。

    参数

    instancer

    仅注册被接受时保活的原生分配器。

    name
    string

    精确原生类型,包含 checked、event 及 value。

    返回值

    void
    源码与继承
  • 对应 RegisterDataViewInstancer;保留首次注册。

    参数

    instancer

    仅注册被接受时保活的原生分配器。

    name
    string

    精确绑定类型;无法替换已有默认注册。

    structural
    boolean = false

    将绑定解析为结构视图。

    返回值

    void
    源码与继承
  • 注册原生非自有元素实例器,保活至运行时关闭。

    参数

    name
    string

    注册名;原生 RmlUi 转为小写。

    instancer

    有类型的原生适配器;null 禁用此注册名。

    返回值

    void
    源码与继承

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0