API reference
Preparing search index…

Checked path into an Rml::DataVariable; resolves native storage on each call.

Source & inheritance
Member directory14

Constructors

Accessors

Methods

Constructors

  • Create an invalid variable, wrap a checked lease, or allocate native-owned storage using a registered schema and its initial value.

    Parameters

    handle

    Registered schema or internal lease; omit for invalid.

    initialValueOptional
    unknown

    Schema storage or custom payload; omit for defaults.

    Returns

    Source & inheritance
  • Create an invalid variable or wrap an internal checked native lease.

    Parameters

    handleOptional
    object

    Internal native lease; omit to create an invalid variable.

    Returns

    Source & inheritance

Accessors

  • get isValid(): boolean

    Whether the literal, model path or owned storage currently resolves.

    Returns

    boolean

    Current native variable validity.

    Source & inheritance
  • get size(): number

    Rml::DataVariable::Size; non-arrays return the native default zero.

    Returns

    number

    Native array size.

    Source & inheritance

Methods

  • Resolve a checked definition through native DataVariableAccessor. Registered schemas retain identity; other definitions retain this variable.

    Returns

    Registered schema or a checked variable-bound definition.

    Source & inheritance
  • Read the retained payload of a custom native storage node.

    Returns

    unknown

    Caller payload with its original identity.

    Source & inheritance
  • Inspect native VariableDefinition::ReflectMemberNames.

    Returns

    string[]

    Reflected member names.

    Source & inheritance
  • Resize native array storage without automatically dirtying its root. Allowed synchronously in data events; forbidden in value callbacks and intervening nested listeners.

    Parameters

    count
    number

    Nonnegative length; new members receive native defaults.

    Returns

    boolean

    Whether resizing succeeded.

    Source & inheritance
  • Replace or clear a managed target. Dirty affected view roots afterwards. The target must have the registered underlying definition.

    Parameters

    target

    Checked variable, or null to clear.

    Returns

    boolean

    True when the target is assigned.

    Source & inheritance

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