API reference
Preparing search index…

RmlUi event snapshot with callback-scoped native propagation controls.

Each listener receives its own snapshot, including projected coordinates. Saved fields remain readable. Propagation getters and stop methods throw after that callback returns, even while other listeners are still running. The id identifies the event type, not a unique dispatch.

Type hierarchy

Hierarchy (View Summary)

Source & inheritance
Member directory25

Constructors

Properties

Accessors

Methods

Constructors

  • Construct an owned Rml::Event with the upstream default state.

    Returns

    Requires an initialized runtime. Target and current element are null, type and parameters are empty, id is Invalid and phase is None. The event is noninterruptible. Native ownership ends on release, GC or shutdown, while saved fields remain readable.

    Source & inheritance

Properties

id: number

Native EventId.

Source & inheritance
isInterruptible: boolean

Interruptible flag.

Source & inheritance
parameters: Readonly<Record<string, VariantValue>>

Typed parameters copied from Rml::Event::GetParameters.

Source & inheritance
target: null | Element

Target element, or null for a default-constructed event.

Source & inheritance
targetId: string

Target id snapshot.

Source & inheritance
type: string

Event type.

Source & inheritance
unprojectedMouseScreenPosition: VariantVector2

Rml::Event::GetUnprojectedMouseScreenPos snapshot in physical pixels.

Source & inheritance

Accessors

  • get isImmediatePropagating(): boolean

    Rml::Event::IsImmediatePropagating while the native event is live.

    Returns

    boolean

    Whether remaining listeners on this element may run.

    Source & inheritance
  • get isPropagating(): boolean

    Rml::Event::IsPropagating while the native event is live.

    Returns

    boolean

    Whether propagation may continue.

    Source & inheritance

Methods

  • Read an element-valued parameter through a checked pointer adapter.

    Parameters

    name
    string

    Native parameter name.

    defaultValue
    null | Element = null

    Live fallback element or null; defaults to null.

    Returns

    null | Element

    Canonical element or fallback when native conversion fails.

    Supports native ScriptInterface element values and the exact upstream drag_element pointer contract. Arbitrary pointers are rejected. Native event/reference validity is checked on every call; no pointer is stored in a persistent attribute. Snapshots do not alter live parameters.

    Source & inheritance
  • Rml::Event::GetParameter conversion while the native event is live.

    Type Parameters

    Parameters

    name
    string

    Native parameter name.

    defaultValue

    Non-null owned Variant selecting T.

    Returns

    Native conversion result, or the default for missing parameters.

    Reads live projected parameters, independent of the JS snapshot. Numbers select double; BigInt selects int64, or uint64 above INT64_MAX. RmlUi conversion rules apply: nonnumeric strings convert to number 0. Unsafe integer overflow throws. A scriptinterface selector reads guarded Element, Context or Event pointers; native expiry returns null. Vectors and colours are copied. Use parameters for retained raw values.

    Source & inheritance
  • Read native GetScriptObject; unregistered events return null.

    Returns

    null | object

    Registered host object or null; expired callback leases throw.

    Source & inheritance
  • Rml::Event equality operators, using the retained type/id snapshot.

    Parameters

    type
    string | number

    Event name or native id.

    Returns

    boolean

    Whether this event has the given type.

    Source & inheritance
  • Release a live owned event through its native deleter.

    Returns

    void

    Factory and direct allocations support release; callback leases reject. Snapshot fields remain readable. Native deletion also runs on GC and shutdown. Release callbacks run only at a subsequent safe boundary.

    Source & inheritance
  • Rml::Event::SetCurrentElement, including native mouse projection.

    Parameters

    element
    null | Element

    Live current element, or null.

    Returns

    void
    Source & inheritance
  • Rml::Event::SetPhase; update the retained phase after native validation.

    Parameters

    phase

    Native None, Capture, Target or Bubble phase.

    Returns

    void
    Source & inheritance
  • Register a managed script object on this live native event.

    Parameters

    object
    null | object

    Host object, or null to clear the association.

    Returns

    void

    Listener leases share the actual native event association. Each borrowed facade still expires after its callback. Owned event cycles can collect.

    Source & inheritance
  • Rml::Event::StopImmediatePropagation; also stop remaining local listeners.

    Returns

    void
    Source & inheritance
  • Rml::Event::StopPropagation; finish listeners at the current DOM level.

    Returns

    void
    Source & inheritance

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