API reference
Preparing search index…

Native-owned Rml::Property copy, valid for its RmlUi runtime generation.

DOM updates cannot change this copy. Shutdown clears resource references and invalidates native operations; mapped metadata remains independent storage. Raw conversion supports scalars, vectors, colours, live elements, decoration lists, transforms and transition/animation lists. Decorator, filter and font-effect values retain generation-owned shared native resources.

Source & inheritance
Member directory17

Constructors

Accessors

Methods

Constructors

  • Construct a property; one numeric argument selects the enum overload.

    Parameters

    valueOptional

    Owned Variant; omitted means NONE.

    unitOptional

    Unit; omitted numeric values use KEYWORD, others UNKNOWN.

    specificity
    number = -1

    Cascade specificity, default -1.

    Returns

    Source & inheritance

Accessors

  • get parserIndex(): number

    Mapped parser_index used by PropertyDefinition::GetValue.

    Returns

    number

    Native parser index, initially -1.

    Source & inheritance
  • set parserIndex(value: number): void

    Set the native parser index.

    Parameters

    value
    number

    Signed 32-bit index.

    Returns

    void
    Source & inheritance
  • get parserIndexView(): Int32Array

    Writable one-integer view of native parser_index.

    Returns

    Int32Array

    Shared parser index storage, reset to -1 on shutdown.

    Source & inheritance
  • get specificity(): number

    Mapped cascade specificity, excluded from native equality.

    Returns

    number

    Signed native integer.

    Source & inheritance
  • set specificity(value: number): void

    Set native cascade specificity.

    Parameters

    value
    number

    Signed 32-bit specificity.

    Returns

    void
    Source & inheritance
  • get specificityView(): Int32Array

    Writable one-integer view of native specificity.

    Returns

    Int32Array

    Shared specificity storage, reset to -1 on shutdown.

    Source & inheritance
  • get unitView(): Int32Array

    Writable native unit storage, synchronized at each native operation.

    Returns

    Int32Array

    Shared unit storage, reset to UNKNOWN on shutdown.

    Source & inheritance

Methods

  • Convert through Rml::Property::Get<ScriptInterface*> and narrow to Element.

    Returns

    null | Element

    Live element, or null for failed conversion or destruction.

    Source & inheritance
  • Rml::Property::ToString with its native definition and unit.

    Returns

    string

    Native property text.

    TypeError for pointer values or serialized effect properties containing pointers.

    Source & inheritance

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