API reference
Preparing search index…

DataModelConstructor

Rml::DataModelConstructor with native-owned bindings.

Type hierarchy

Hierarchy (View Summary)

Source & inheritance
Member directory19

Constructors

Accessors

Methods

Constructors

Accessors

  • get isValid(): boolean

    Whether the owning model and context still exist.

    Returns

    boolean

    Native lease validity.

    Source & inheritance

Methods

  • Assign sparse scalar paths and dirty only their successfully changed roots.

    Parameters

    patches
    Record<string, DataScalarValue>

    Native paths, optionally prefixed with "$.".

    Returns

    boolean

    Whether every assignment succeeded.

    Source & inheritance
  • Bind Rml::DataModelConstructor::BindEventCallback.

    Parameters

    name
    string

    Expression callback name.

    callback

    Live event callback.

    Returns

    boolean

    Native binding result.

    Source & inheritance
  • Bind Rml::DataModelConstructor::BindFunc.

    Parameters

    name
    string

    Root name.

    getter

    Owned Variant getter.

    setterOptional

    Optional setter; omitted bindings are read-only.

    Returns

    boolean

    Native binding result.

    Source & inheritance
  • Snapshot bound native roots through DataModelConstructorAccessor. Variables keep resolving current storage; later roots are absent.

    Returns

    Record<string, DataVariable>

    Root names mapped to checked variables.

    Source & inheritance
  • Resolve a native model address string or explicit address entries. String paths may begin with "$."; explicit entries copy both fields.

    Parameters

    path
    string | DataAddress

    Root, member or indexed native address.

    Returns

    Checked variable, or null when unresolved.

    Source & inheritance
  • Read Rml::DataModelHandle::IsVariableDirty for a root name.

    Parameters

    name
    string

    Bound root variable name.

    Returns

    boolean

    Native dirty state.

    Source & inheritance
  • Register indexed native storage over an existing element definition.

    Parameters

    name
    string

    Runtime schema name.

    element

    Element definition from this native register.

    Returns

    null | DataSchema

    Array definition, or null for a duplicate name.

    Source & inheritance
  • Register custom native Get/Set/Size/Child/reflection behavior.

    Type Parameters

    • T

      Bound caller payload type.

    Parameters

    name
    string

    Runtime schema name.

    definition

    Native callback contract.

    Returns

    null | DataSchema

    Definition, or null for a duplicate name.

    Source & inheritance
  • Register an empty native record in the constructor's type register.

    Parameters

    name
    string

    Runtime schema name.

    Returns

    Record handle, or null for a duplicate name.

    Source & inheritance
  • Register a context-wide Rml::DataModelConstructor::RegisterTransformFunc.

    Parameters

    name
    string

    Transform name.

    callback

    Native expression argument transform.

    Returns

    void
    Source & inheritance
  • Execute native DataModel::Update; Context.update also performs this step.

    Parameters

    clearDirtyVariables
    boolean = true

    Clear root dirty marks; defaults to true.

    Returns

    boolean

    Whether native views changed.

    Source & inheritance

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