Simulation Instruments

Home›All functions›Inter-instrument

Inter-instrument

Simulation Instrument Studio 1

si_variable_create

Simulation Instrument Studio 1

Definition

var_id = si_variable_create(variable, unit, initial_value)

Remarks

Create a new Studio inter-instrument variable.

Example

No sample instrument calls this yet.

si_variable_create()
Photo slot: shots/si_variable_create.png

si_variable_subscribe

Simulation Instrument Studio 1

Definition

si_variable_subscribe(variable, unit, callback_function)

Remarks

Subscribe to specified Studio variable(s).

Parameters

NameDescription
variableName of the variable to read or write.
unitUnit of the value, such as Feet or Degrees.
callback_functionFunction called when the value changes.

Example

No sample instrument calls this yet.

si_variable_subscribe(variable, unit, function() end)
Photo slot: shots/si_variable_subscribe.png

si_variable_write

Simulation Instrument Studio 1

Definition

si_variable_write(var_id, value)

Remarks

Write to an Studio variable.

Parameters

NameDescription
var_idId returned by the call that created the object.
valueThe value to write.

Example

No sample instrument calls this yet.

si_variable_write(var_id, value)
Photo slot: shots/si_variable_write.png

si_command_subscribe

Simulation Instrument Studio 1

Definition

si_command_subscribe(command, callback_function)

Remarks

Subscribe to specified Studio command(s).

Parameters

NameDescription
commandSimulator command name.
callback_functionFunction called when the value changes.

Example

No sample instrument calls this yet.

si_command_subscribe("...", function() end)
Photo slot: shots/si_command_subscribe.png

si_command

Simulation Instrument Studio 1

Definition

si_command(command)

Remarks

Send an Studio command.

Parameters

NameDescription
commandSimulator command name.

Example

No sample instrument calls this yet.

si_command("...")
Photo slot: shots/si_command.png

variable_subscribe

Simulation Instrument Studio 1

Definition

variable_subscribe(source, variable_name, type, callback_function)

Remarks

Subscribe to multiple sources (X-Plane, FSX, SI, etc.) using one subscription.

Parameters

NameDescription
sourceWhere the value comes from. A layer name, or a map source tag.
variable_nameProperty or object name.
typeValue type: FLOAT, INT, DOUBLE, or an array type such as FLOAT[8].
callback_functionFunction called when the value changes.

Example

No sample instrument calls this yet.

variable_subscribe(source, variable_name, "FLOAT", function() end)
Photo slot: shots/variable_subscribe.png

request_callback

Simulation Instrument Studio 1

Definition

request_callback(callback_function)

Remarks

Force an update on a subscription.

Parameters

NameDescription
callback_functionFunction called when the value changes.

Example

No sample instrument calls this yet.

request_callback(function() end)
Photo slot: shots/request_callback.png