API reference
Preparing search index…

DataStructHandle

Runtime struct registration corresponding to Rml::DataStructHandle.

Type hierarchy

Hierarchy (View Summary)

Source & inheritance
Member directory10

Constructors

Accessors

Methods

Constructors

Accessors

  • get familyId(): number

    Identity allocated by Rml::FamilyBase, valid only within this runtime.

    Returns

    number

    Native family identity.

    Source & inheritance
  • get isCustom(): boolean

    Whether the definition invokes custom Get/Set/Size/Child/reflection.

    Returns

    boolean

    Custom definition classification.

    Source & inheritance
  • get isEnum(): boolean

    Whether the definition stores checked native enum values.

    Returns

    boolean

    Enum classification.

    Source & inheritance
  • get isReference(): boolean

    Whether this definition forwards to a managed nullable target.

    Returns

    boolean

    Managed reference classification.

    Source & inheritance
  • get isValid(): boolean

    Whether the register or variable owner remains valid.

    Returns

    boolean

    Definition validity.

    Source & inheritance
  • get underlying(): null | DataSchema

    Array element or managed reference target definition; otherwise null.

    Returns

    null | DataSchema

    Canonical underlying definition.

    Source & inheritance

Methods

  • Invoke native VariableDefinition::ReflectMemberNames. Unregistered definitions resolve the variable path on every operation.

    Returns

    string[]

    Reflected member names in native order.

    Source & inheritance
  • Add storage or a getter/setter member; schemas freeze at storage creation.

    Parameters

    name
    string

    Reflected member name.

    schema

    Definition from the same type register.

    getterOptional

    Read current parent; return a value or checked reference.

    setterOptional

    Optional scalar value setter, with native void semantics.

    Returns

    boolean

    False for duplicate member names.

    Source & inheritance

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