API reference
Preparing search index…

Checked Rml::EventDispatcher owned by its native element.

Registrations share Element's listener identity and ownership index. Destruction or shutdown invalidates this view. Its token retains detached elements. Notifications run after native unwinding at the outer boundary.

Source & inheritance
Member directory5

Methods

Methods

  • Rml::EventDispatcher::AttachEvent using the existing listener registry.

    Parameters

    id
    string | number

    Registered id or event name.

    listener

    Function or typed native listener.

    capture
    boolean = false

    Capture registration; defaults to false.

    Returns

    void

    Duplicate element/id/listener/capture registrations are idempotent.

    Source & inheritance
  • Recursively detach every listener, including non-DOM child dispatchers.

    Returns

    void

    Also removes upstream widget listeners. Active callbacks finish safely; later detached listeners are skipped. Typed detach hooks use copied identities and execute after the outer native call returns.

    Source & inheritance
  • Rml::EventDispatcher::DetachEvent; unmatched registrations do nothing.

    Parameters

    id
    string | number

    Same event id or name used when attaching.

    listener

    Same listener reference.

    capture
    boolean = false

    Same capture flag; defaults to false.

    Returns

    void
    Source & inheritance
  • Copy Rml::EventDispatcher::ToString with native event names and counts.

    Returns

    string

    Empty string when no listeners are registered.

    Source & inheritance
  • Rml::EventDispatcher::DispatchEvent with every upstream flag explicit.

    Parameters

    target

    Live target element.

    id
    number

    Native EventId used to select listeners.

    type
    string

    Explicit event name, independent of the registry name.

    parameters
    Readonly<Record<string, VariantValue>>

    Typed native Variant parameters.

    interruptible
    boolean

    Whether listeners may stop propagation.

    bubbles
    boolean

    Whether ancestor bubble listeners execute.

    defaultActionPhase

    None, Target or TargetAndBubble.

    Returns

    boolean

    Whether propagation remains enabled.

    Uses these flags without consulting registered defaults. Upstream runs TargetAndBubble default actions on ancestors even when bubbles is false. Parameter accessors run before native target validation.

    Source & inheritance

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