API reference
Preparing search index…

ScriptInterface

Abstract

Typed base for checked Rml::ScriptInterface objects.

Context, Element and RmlEvent retain their ownership and release rules. Unregistered objects return null from GetScriptObject. setScriptObject installs a managed native owner; JS subclassing does not change native RTTI.

Type hierarchy

Hierarchy (View Summary)

Source & inheritance
Member directory7

Constructors

Methods

Constructors

Methods

  • Read the live native script object through its typed adapter.

    Returns

    null | object

    Registered host object, or the upstream default null.

    Source & inheritance
  • Release an owned object through its original native allocation chain.

    Returns

    void

    Attached elements and borrowed events reject release. Concrete facades define their exact rules; GC and shutdown also end native ownership.

    Source & inheritance
  • Register a host object on the actual native ScriptInterface.

    Parameters

    object
    null | object

    Managed object, or null to remove its native association.

    Returns

    void

    Native ownership retains the object; detached JS ownership allows cycles to collect. Foreign native script overrides require their own adapter.

    Source & inheritance

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