API reference
Preparing search index…

Checked Rml::Factory instancing, parsing and cache operations.

Parsing is synchronous and consumes the stream at its current position. Native instancers and translators run normally. Parsing and cache mutation reject callback reentry. Shutdown invalidates returned native owners. Stylesheets return null when no rules were parsed, and may return partially parsed rules after native syntax diagnostics.

Source & inheritance
Member directory23

Methods

Methods

  • Invoke Rml::Factory::ClearStyleSheetCache; live containers remain valid.

    Returns

    void
    Source & inheritance
  • Invoke Rml::Factory::ClearTemplateCache for subsequent template loads.

    Returns

    void
    Source & inheritance
  • Read the exact native registration, falling back to "*" for unknown tags.

    Parameters

    tag
    string

    Exact lookup key; unlike registration it is not lowercased.

    Returns

    Canonical instancer or null if the fallback is absent.

    Source & inheritance
  • Copy Rml::Factory::GetStructuralDataViewAttributeNames.

    Returns

    string[]

    Independent array of full "data-" names in native set order.

    Source & inheritance
  • Invoke Rml::Factory::InstanceContext without Core registration.

    Parameters

    name
    string

    Exact name passed to the selected native allocator.

    manager

    Live render manager borrowed by the native context.

    handler

    Borrowed native text-input handler, or null.

    Returns

    null | Context

    Owned context, or null if the allocator declines creation.

    Retains native default dimensions and density. Use setDimensions before layout or rendering. Descendants retain the owner; remove releases it without removing a registered context with the same name.

    Source & inheritance
  • Invoke InstanceDataController and return the actual native owner.

    Parameters

    name
    string

    Exact registered controller type.

    element

    Live requesting element.

    Returns

    Owned controller or null; Initialize attaches native listeners.

    Source & inheritance
  • Invoke InstanceDataView and return an actual owning native view.

    Parameters

    name
    string

    Registered native view type.

    element

    Live requesting element.

    Returns

    null | DataView

    Owned view or null; manual use does not register scheduling.

    Source & inheritance
  • Parse an owned document without inserting it into the context.

    Parameters

    context

    Native context borrowed by the document.

    stream

    Open stream consumed from its current position.

    documentBaseTag
    string

    Registered native document instancer and tag.

    Returns

    null | Document

    Detached document, or null when native creation fails.

    Uses Rml::Factory::InstanceDocumentStream, including the stream source URL and native document-header processing. It does not dispatch context load notifications. The document owns its tree; descendants keep it alive. Context removal or shutdown destroys this tree before releasing resources. Host stream exceptions propagate; native syntax diagnostics may leave a partial document, following RmlUi's parser result.

    Source & inheritance
  • Invoke Rml::Factory::InstanceElement without attaching the returned node.

    Parameters

    parent
    null | Element

    Parent supplied to the native instancer, or null for roots.

    instancer
    string

    Registered instancer name; "*" supplies the fallback.

    tag
    string

    Actual tag, independent of the instancer name.

    attributes
    Record<string, VariantValue> = {}

    Owned Variant attributes applied by native Factory.

    Returns

    null | Element

    Owned detached element with native subtype, or null on failure.

    Source & inheritance
  • Invoke Rml::Factory::InstanceElementStream to append parsed children.

    Parameters

    parent

    Receiving element; context roots are rejected.

    stream

    Open native stream with its own source URL.

    Returns

    boolean

    Upstream result; host read errors throw. Syntax diagnostics can leave partial children because RmlUi 6.3 returns true after parsing.

    Source & inheritance
  • Translate, decode and append native text or RML elements to the parent.

    Parameters

    parent

    Element receiving parsed children.

    text
    string

    UTF-8 text, RML entities or RML markup.

    Returns

    boolean

    Native parser result; whitespace adds no child.

    Source & inheritance
  • Rml::Factory::InstanceEvent; return an owned, undispatched event.

    Parameters

    target

    Live target element.

    id
    number

    Registered native event id.

    type
    string

    Native event type.

    parameters
    Readonly<Record<string, VariantValue>>

    Typed parameter dictionary.

    interruptible
    boolean

    Whether native propagation may stop.

    Returns

    null | RmlEvent

    Owned event, or null if declined.

    Source & inheritance
  • Invoke Rml::Factory::InstanceEventListener without attaching the result.

    Parameters

    value
    string

    Exact inline attribute value.

    element

    Live requesting element.

    Returns

    Unattached listener or null if disabled or declined.

    Source & inheritance
  • Create a container through the native file interface and Factory parser.

    Parameters

    filename
    string

    RCSS filename resolved by the installed file interface.

    Returns

    Owned container, or null if open or parsing fails.

    Source & inheritance
  • Query Rml::Factory::IsStructuralDataView using the unprefixed type name.

    Parameters

    name
    string

    Exact type name, such as "for".

    Returns

    boolean

    Whether native parsing treats this data view as structural.

    Source & inheritance
  • Rml::Factory::RegisterDataControllerInstancer; first registration wins.

    Parameters

    instancer

    Allocator retained only for accepted registration.

    name
    string

    Exact native type, including "checked", "event" and "value".

    Returns

    void
    Source & inheritance
  • Rml::Factory::RegisterDataViewInstancer; first registration wins.

    Parameters

    instancer

    Native allocator retained only if registered.

    name
    string

    Exact binding type; existing defaults cannot be replaced.

    structural
    boolean = false

    Parse as a structural view; defaults to false.

    Returns

    void
    Source & inheritance
  • Register a non-owning native element instancer, retained through shutdown.

    Parameters

    name
    string

    Registration name, lowercased by native RmlUi.

    instancer

    Typed native adapter, or null to disable this name.

    Returns

    void
    Source & inheritance

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