API reference
Preparing search index…

DataCustomDefinition<T>

Real native VariableDefinition callbacks over a retained JS payload. Omitted callbacks use native defaults: false, zero, null, or an empty list.

interface DataCustomDefinition<T = unknown> {
    type: DataVariableType;
    child(payload: T, address: string | number): null | DataVariable;
    get(payload: T): DataGetResult;
    reflectMemberNames(): readonly string[];
    set(payload: T, value: DataVariantValue): boolean;
    size(payload: T): number;
}

Type Parameters

  • T = unknown

    Payload retained by each bound native storage node.

Source & inheritance
Member directory6

Properties

Methods

Properties

Rml::DataVariableType category.

Source & inheritance

Methods

  • Return a checked variable from the same register, or null.

    Parameters

    payload

    Bound data.

    address
    string | number

    Member name or array index, including the name "size".

    Returns

    Checked child; native execution temporarily retains its lease.

    Source & inheritance
  • Return schema-level member names for native reflection and Debugger.

    Returns

    readonly string[]

    Reflected names.

    Source & inheritance
  • Return an array length within the nonnegative native int range.

    Parameters

    payload

    Bound data.

    Returns

    number

    Native array length.

    Source & inheritance

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