Skip to main content

Interface: RegisteredSimVar<T>

Defined in: src/sdk/data/SimVars.ts:306

A registered SimVar.

Type Parameters

Type Parameter
T

Properties

dataSource

readonly dataSource: string

Defined in: src/sdk/data/SimVars.ts:314

The data source linked to this SimVar.


name

readonly name: string

Defined in: src/sdk/data/SimVars.ts:308

The name of this SimVar.


unit

readonly unit: string

Defined in: src/sdk/data/SimVars.ts:311

The unit type of this SimVar.

Methods

get()

get(): T

Defined in: src/sdk/data/SimVars.ts:320

Gets the value of this SimVar.

Returns

T

The value of this SimVar.


set()

set(value): Promise<void>

Defined in: src/sdk/data/SimVars.ts:327

Sets the value of this SimVar.

Parameters

ParameterTypeDescription
valueTThe value to set.

Returns

Promise<void>

A Promise which is fulfilled when the operation to set the SimVar value has been successfully sent.