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

RmlUi 事件快照,原生传播控制仅在当前回调期间有效。

每个监听器收到独立快照,包含投影后的坐标。保存的字段可继续读取。 回调返回后,即使其他监听器仍在执行,传播状态和停止方法也会抛出异常。 id 标识事件类型,并非某次派发的唯一编号。

继承关系

层级 (查看层级一览)

源码与继承
成员目录25

构造函数

属性

访问器

方法

构造函数

  • 构造具有上游默认状态的自有 Rml::Event。

    返回值

    需要已初始化的运行时。目标与当前元素为 null,类型和参数为空, 编号为 Invalid,阶段为 None。事件不可中断;release、GC 或关闭释放原生 所有权,保存的字段仍可读取。

    源码与继承

属性

id: number

原生 EventId。

源码与继承
isInterruptible: boolean

是否可中断。

源码与继承
parameters: Readonly<Record<string, VariantValue>>

从 Rml::Event::GetParameters 复制的带类型参数。

源码与继承
target: null | Element

目标元素;默认构造的事件为 null。

源码与继承
targetId: string

目标 id 快照。

源码与继承
type: string

事件类型。

源码与继承
unprojectedMouseScreenPosition: VariantVector2

Rml::Event::GetUnprojectedMouseScreenPos 快照,单位为物理像素。

源码与继承

访问器

  • get isImmediatePropagating(): boolean

    Rml::Event::IsImmediatePropagating,原生事件有效期间可用。

    返回值

    boolean

    当前元素的后续监听器是否可以继续执行。

    源码与继承
  • get isPropagating(): boolean

    Rml::Event::IsPropagating,原生事件有效期间可用。

    返回值

    boolean

    是否可以继续传播。

    源码与继承

方法

  • 通过受检指针适配器读取元素参数。

    参数

    name
    string

    原生参数名。

    defaultValue
    null | Element = null

    有效备用元素或 null,默认为 null。

    返回值

    null | Element

    身份唯一的元素;原生转换失败时返回备用值。

    支持原生 ScriptInterface 元素值及上游 drag_element 指针契约, 拒绝任意指针。每次检查事件及引用的有效性,不向持久属性保存指针。 快照修改不会改变实时参数。

    源码与继承
  • Rml::Event::GetParameter 类型转换,原生事件有效期间可用。

    类型参数

    参数

    name
    string

    原生参数名。

    defaultValue

    选择 T 的非空自有 Variant。

    返回值

    原生转换结果;参数缺失时返回默认值。

    读取实时投影参数,不受 JS 快照修改影响。number 选择 double; BigInt 选择 int64,超过 INT64_MAX 时选择 uint64。遵循 RmlUi 规则, 非数字字符串转换为 number 时得到 0。整数溢出抛出异常; scriptinterface 样本读取受保护的 Element、Context 或 Event 指针; 原生目标失效时返回 null。 向量和颜色返回副本;需要保留原始值时使用 parameters。

    源码与继承
  • 读取原生 GetScriptObject;未注册事件返回 null。

    返回值

    null | object

    已注册的宿主对象或 null;回调借用过期时抛出异常。

    源码与继承
  • 使用保留的类型或编号快照实现 Rml::Event 相等运算。

    参数

    type
    string | number

    事件名或原生编号。

    返回值

    boolean

    事件是否具有指定类型。

    源码与继承
  • 通过原生删除器释放活跃自有事件。

    返回值

    void

    支持 Factory 及直接分配;拒绝回调借用事件。快照仍可读取。 GC 和关闭也会原生删除;释放回调只在之后的安全边界执行。

    源码与继承
  • 调用 SetCurrentElement,包含原生鼠标坐标投影。

    参数

    element
    null | Element

    活跃当前元素,或 null。

    返回值

    void
    源码与继承
  • 调用 SetPhase,原生校验后更新保留阶段。

    参数

    phase

    原生 None、Capture、Target 或 Bubble 阶段。

    返回值

    void
    源码与继承
  • 在此有效原生事件上注册托管脚本对象。

    参数

    object
    null | object

    宿主对象,或传 null 清除关联。

    返回值

    void

    监听器借用共享实际原生事件的关联;每个借用包装仍在回调后过期。 自有事件形成的环可回收。

    源码与继承
  • Rml::Event::StopImmediatePropagation;同时停止当前元素的后续监听器。

    返回值

    void
    源码与继承
  • Rml::Event::StopPropagation;当前 DOM 层级的监听器仍会执行完毕。

    返回值

    void
    源码与继承

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