API reference
Preparing search index…

DataTypeRegister

Rml::DataTypeRegister, owned independently or borrowed from one context.

Source & inheritance
Member directory12

Constructors

Accessors

Methods

Constructors

Accessors

  • get isValid(): boolean

    Whether the register survives in its original runtime generation.

    Returns

    boolean

    Register validity.

    Source & inheritance

Methods

  • Allocate a native Rml::FamilyId for caller-selected registration. The identity can be reused across registers in this runtime generation.

    Returns

    number

    Native family identity.

    Source & inheritance
  • Look up a registered native definition by name or family identity.

    Parameters

    name
    string | number

    Schema name or family identity.

    Returns

    null | DataSchema

    Definition, or null when absent.

    Source & inheritance
  • Register an indexed native array of an existing schema.

    Parameters

    name
    string

    Unique schema name.

    element

    Element definition from this register.

    Returns

    null | DataSchema

    Array definition, or null for a duplicate name.

    Source & inheritance
  • Register a native VariableDefinition over retained caller payloads.

    Type Parameters

    • T

      Bound payload type.

    Parameters

    name
    string

    Unique runtime schema name.

    definition

    Native callback contract.

    Returns

    null | DataSchema

    Definition, or null for a duplicate name.

    Source & inheritance
  • Transfer a custom native definition under a selected Rml::FamilyId. Duplicate identities or names return false without retaining callbacks.

    Type Parameters

    • T

      Payload retained by each bound native storage node.

    Parameters

    familyId
    number

    Identity allocated in this runtime generation.

    name
    string

    Unique schema name in this register.

    definition

    Native adapter callbacks over retained payloads.

    Returns

    boolean

    Whether native RegisterDefinition accepted the definition.

    Source & inheritance
  • Register a nullable reference to a definition from this register. Bind with a DataVariable or null. Core 6.3 disallows pointer-to-pointer types.

    Parameters

    name
    string

    Unique schema name.

    target

    Registered non-reference target definition.

    Returns

    null | DataSchema

    Definition, or null for a duplicate name.

    Source & inheritance

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