Interface Mapping

Interface representing a mapping of key-value pairs. Corresponds to the MappingVar class in the C++ API.

interface Mapping {
    get entries(): IterableIterator<[Vrpc.Variant, Vrpc.Variant]>;
    get keys(): IterableIterator<Vrpc.Variant>;
    get size(): number;
    get values(): IterableIterator<Vrpc.Variant>;
    clear(): void;
    convertToObject(manager?: WinccoaManager): object;
    delete(key: Vrpc.Variant): boolean;
    get(key: Vrpc.Variant): Vrpc.Variant;
    has(key: Vrpc.Variant): boolean;
    set(key: Vrpc.Variant, value: Vrpc.Variant): void;
}

Index

Accessors

entries keys size values

Methods

clear convertToObject delete get has set

Accessors

entries

get entries(): IterableIterator<[Vrpc.Variant, Vrpc.Variant]>
Gets an iterator for the key-value pairs in the mapping.

Returns IterableIterator<[Vrpc.Variant, Vrpc.Variant]>
An iterator for the key-value pairs.

keys

get keys(): IterableIterator<Vrpc.Variant>
Gets an iterator for the keys in the mapping.

Returns IterableIterator<Vrpc.Variant>
An iterator for the keys.

size

get size(): number
The number of key-value pairs in the mapping.

Returns number

values

get values(): IterableIterator<Vrpc.Variant>
Gets an iterator for the values in the mapping.

Returns IterableIterator<Vrpc.Variant>
An iterator for the values.

Methods

clear

clear(): void
Clears all key-value pairs from the mapping.

Returns void

convertToObject

convertToObject(manager?: WinccoaManager): object
Converts the Mapping to a JavaScript object.
Parameters
- Optionalmanager: WinccoaManager
  The manager to get formating options from.
Returns object
The converted object.

delete

delete(key: Vrpc.Variant): boolean
Deletes a key-value pair from the mapping.
Parameters
- key: Vrpc.Variant
  The key to delete.
Returns boolean
True if the key was deleted, false otherwise.

get

get(key: Vrpc.Variant): Vrpc.Variant
Gets the value associated with a given key.
Parameters
- key: Vrpc.Variant
  The key to look up.
Returns Vrpc.Variant
The value associated with the key.

has

has(key: Vrpc.Variant): boolean
Checks if a given key exists in the mapping.
Parameters
- key: Vrpc.Variant
  The key to check.
Returns boolean
True if the key exists, false otherwise.

set

set(key: Vrpc.Variant, value: Vrpc.Variant): void
Sets a value for a given key in the mapping.
Parameters
- key: Vrpc.Variant
  The key for the value.
- value: Vrpc.Variant
  The value to set.
Returns void