Simulators

Simulation Instrument Studio 1

xpl_command

Simulation Instrument Studio 1

Overloads

xpl_command(commandref)

Fires an X-Plane command once, or begins and ends a held command.

Parameters

#	Name	Type	Description
1	commandref	String	Reference to a command from X-Plane (see here)
2	value	Number	Optional field. From AM/, you can set this argument to 'BEGIN', 'ONCE' or 'END' command. Older versions can use provide 1 for a BEGIN command, or 0 for an END command.

Example

-- Ident, once
xpl_command("sim/instruments/transponder_ident")

xpl_command_subscribe

Simulation Instrument Studio 1

Overloads

xpl_command_subscribe(commandref,callback_function)

Calls back when a command begins, continues, or ends.

Parameters

#	Name	Type	Description
1	commandref	String	Reference to a command from X-Plane. You can find the list of available commands here.
2	callback_function	Function	The function to call when a new command has been sent within X-Plane

Example

xpl_command_subscribe("sim/instruments/transponder_ident", function(phase)
    -- phase is 0 begin, 1 continue, 2 end
    visible(ident_lamp, phase ~= 2)
end)

xpl_connected

Simulation Instrument Studio 1

Overloads

xpl_connected()

True when the plugin answers.

Parameters

#	Name	Type	Description
1	connected	Boolean	True is connected, otherwise false.

Example

if xpl_connected() then
    remove(flag)
end

xpl_dataref_subscribe

Simulation Instrument Studio 1

Overloads

xpl_dataref_subscribe(dataref,type,...,callback_function)

Subscribes to one dataref, or several dataref and type pairs. The callback receives the values in that order.

Parameters

#	Name	Type	Description
1 .. n	variable	String	Reference to a dataref from X-Plane (see X-Plane DataRefs)
2 .. n	unit	String	Data type of the DataRef, can be INT,FLOAT,DOUBLE,INT[n],FLOAT[n],DOUBLE[n], BYTE[n] or STRING
last	callback_function	Function	The function to call when new data is available

Example

-- One dataref, or several pairs. Values arrive in that order.
xpl_dataref_subscribe(
    "sim/cockpit2/gauges/indicators/altitude_ft_pilot", "FLOAT",
    "sim/cockpit2/gauges/indicators/airspeed_kts_pilot", "FLOAT",
    function(alt_ft, ias)
        txt_set(alt, tostring(math.floor(alt_ft)))
        rotate(needle, ias * 2)
    end)

Example: one value, and a pair

xpl_dataref_subscribe("sim/cockpit2/gauges/indicators/altitude_ft_pilot", "FLOAT", function(ft)
    txt_set(alt, tostring(math.floor(ft)))
end)

-- Both arrive together, in this order
xpl_dataref_subscribe(
    "sim/cockpit2/gauges/indicators/altitude_ft_pilot", "FLOAT",
    "sim/cockpit2/gauges/indicators/airspeed_kts_pilot", "FLOAT",
    function(ft, kts)
        txt_set(alt, tostring(math.floor(ft)))
        txt_set(ias, tostring(math.floor(kts)))
    end)

xpl_dataref_write

Simulation Instrument Studio 1

Overloads

xpl_dataref_write(dataref,type,value,offset,force)

Writes a dataref. The offset selects an array element.

Parameters

#	Name	Type	Description
1	dataref	String	Reference to a dataref from X-Plane (see X-Plane DataRefs)
2	type	Number	Data type of the DataRef, can be INT, FLOAT, DOUBLE, BYTE, STRING, INT[n], FLOAT[n], DOUBLE[n] or BYTE[n]
3	value	Number	The value to be written
4	offset	Number	Optional field. Only to be used when writing arrays. Your value will start writing at a certain array offset. Starts at 0.
5	force	Boolean	Optional field, When true, the plugin writes the dataref every simulator frame. Make sure to disable the forcing again at some point in your code!

Example

-- Set the altimeter to 29.92
xpl_dataref_write("sim/cockpit2/gauges/actuators/barometer_setting_in_hg_pilot", "FLOAT", 29.92)

msfs_connected

Simulation Instrument Studio 1

Overloads

msfs_connected()

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	connected	Boolean	True is connected, otherwise false

Example

-- Simulator value, not a panel value
msfs_connected("INDICATED ALTITUDE", "Feet")

msfs_event

Simulation Instrument Studio 1

Overloads

msfs_event(event)
msfs_event(event, value_1)
msfs_event(event, value_1, value_2)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	event	String	Reference to an event from Flight Simulator 2020/2024. Use 'H:' prefix for H events, see example below.
2	value_1	Number	(Optional) Send a value with the event. Some events support setting a value.
3	value_2	Number	(Optional) Send a value with the event. Some events support setting a value.

Example

-- Simulator value, not a panel value
msfs_event("INDICATED ALTITUDE", "Feet")

msfs_event_subscribe

Simulation Instrument Studio 1

Overloads

msfs_event_subscribe(event, callback)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	event	String	Reference to the FS2020/FS2024 event
2	callback	Function	The function to call when a new event has been sent within the sim

Example

-- Simulator value, not a panel value
msfs_event_subscribe("INDICATED ALTITUDE", "Feet")

msfs_rpn

Simulation Instrument Studio 1

Overloads

msfs_rpn(rpn_script, callback)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	rpn_script	String	The RPN script to execute within FS2020/FS2024.
2	callback	Function	(Optional) Return value from the executed RPN script. Three arguments are given, first is integer, second is float and third is string. Note that these arguments are nil when script could not be executed. Make sure to nil check in your callback.

Example

-- Simulator value, not a panel value
msfs_rpn("INDICATED ALTITUDE", "Feet")

msfs_variable_subscribe

Simulation Instrument Studio 1

Overloads

msfs_variable_subscribe(variable, unit, callback_function)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1 .. n	variable	String	Reference to a variable from Flight Simulator 2020/2024. Use prefix 'L:' for LVARS, see example below
2 .. n	unit	String	Unit of the variable, can be found with the variable. Different units can be used for different variables. For example Hours, Knots and RPM
last	callback_function	Function	The function to call when new data is available

Example

msfs_variable_subscribe("INDICATED ALTITUDE", "Feet", function(ft)
    txt_set(alt, tostring(math.floor(ft)))
end)

msfs_variable_write

Simulation Instrument Studio 1

Overloads

msfs_variable_write(variable, unit, value)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	variable	String	Reference to a variable from Flight Simulator 2020/2024
2	unit	String	Unit of the variable, can be found with the variable. Different units can be used for different variables. For example Hours, Knots and RPM.
3	value	Number	The value to be written

Example

-- Simulator value, not a panel value
msfs_variable_write("INDICATED ALTITUDE", "Feet")

Photo slot: shots/msfs_variable_write.png

fs2020_connected

Simulation Instrument Studio 1

Overloads

fs2020_connected()

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	connected	Boolean	True is connected, otherwise false

Example

-- Simulator value, not a panel value
fs2020_connected("INDICATED ALTITUDE", "Feet")

fs2020_event

Simulation Instrument Studio 1

Overloads

fs2020_event(event)
fs2020_event(event, type, value)
fs2020_event(event, value)
fs2020_event(event, value, value_2)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	event	String	Reference to an event from Flight Simulator 2020. Use 'H:' prefix for H events, see example below.
2	type	String	(Optional) Data type, can be INT, FLOAT, DOUBLE, BOOL or STRING.
3	value	Number	(Optional) Send a value with the event. Some events support setting a value.
4	value_2	Number	(Optional) Send a value with the event. Some events support setting a value.

Example

-- Simulator value, not a panel value
fs2020_event("INDICATED ALTITUDE", "Feet")

fs2020_event_subscribe

Simulation Instrument Studio 1

Overloads

fs2020_event_subscribe(event, callback)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	event	String	Reference to the FS2020 event
2	callback	Function	The function to call when a new event has been sent within FS2020

Example

-- Simulator value, not a panel value
fs2020_event_subscribe("INDICATED ALTITUDE", "Feet")

fs2020_rpn

Simulation Instrument Studio 1

Overloads

fs2020_rpn(rpn_script, callback)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	rpn_script	String	The RPN script to execute within FS2020.
2	callback	Function	(Optional) Return value from the executed RPN script. Three arguments are given, first is integer, second is float and third is string. Note that these arguments are nil when script could not be executed. Make sure to nil check in your callback.

Example

-- Simulator value, not a panel value
fs2020_rpn("INDICATED ALTITUDE", "Feet")

fs2020_variable_subscribe

Simulation Instrument Studio 1

Overloads

fs2020_variable_subscribe(variable, unit, callback_function)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1 .. n	variable	String	Reference to a variable from Flight Simulator 2020. Use prefix 'L:' for LVARS, see example below
2 .. n	unit	String	Unit of the variable, can be found with the variable. Different units can be used for different variables. For example Hours, Knots and RPM
last	callback_function	Function	The function to call when new data is available

Example

fs2020_variable_subscribe("INDICATED ALTITUDE", "Feet", function(ft)
    txt_set(alt, tostring(math.floor(ft)))
end)

fs2020_variable_write

Simulation Instrument Studio 1

Overloads

fs2020_variable_write(variable, unit, value)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	variable	String	Reference to a variable from Flight Simulator 2020
2	unit	String	Unit of the variable, can be found with the variable. Different units can be used for different variables. For example Hours, Knots and RPM.
3	value	Number	The value to be written

Example

-- Simulator value, not a panel value
fs2020_variable_write("INDICATED ALTITUDE", "Feet")

Photo slot: shots/fs2020_variable_write.png

fs2024_connected

Simulation Instrument Studio 1

Overloads

fs2024_connected()

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	connected	Boolean	True is connected, otherwise false

Example

-- Simulator value, not a panel value
fs2024_connected("INDICATED ALTITUDE", "Feet")

fs2024_event

Simulation Instrument Studio 1

Overloads

fs2024_event(event)
fs2024_event(event, type, value)
fs2024_event(event, value)
fs2024_event(event, value, value_2)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	event	String	Reference to an event from Flight Simulator 2020. Use 'H:' prefix for H events, see example below.
2	type	String	(Optional) Data type, can be INT, FLOAT, DOUBLE, BOOL or STRING.
3	value	Number	(Optional) Send a value with the event. Some events support setting a value.
4	value_2	Number	(Optional) Send a value with the event. Some events support setting a value.

Example

-- Simulator value, not a panel value
fs2024_event("INDICATED ALTITUDE", "Feet")

fs2024_event_subscribe

Simulation Instrument Studio 1

Overloads

fs2024_event_subscribe(event, callback)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	event	String	Reference to the FS2024 event
2	callback	Function	The function to call when a new event has been sent within FS2024

Example

-- Simulator value, not a panel value
fs2024_event_subscribe("INDICATED ALTITUDE", "Feet")

fs2024_rpn

Simulation Instrument Studio 1

Overloads

fs2024_rpn(rpn_script, callback)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	rpn_script	String	The RPN script to execute within FS2024.
2	callback	Function	(Optional) Return value from the executed RPN script. Three arguments are given, first is integer, second is float and third is string. Note that these arguments are nil when script could not be executed. Make sure to nil check in your callback.

Example

-- Simulator value, not a panel value
fs2024_rpn("INDICATED ALTITUDE", "Feet")

fs2024_variable_subscribe

Simulation Instrument Studio 1

Overloads

fs2024_variable_subscribe(variable, unit, callback_function)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1 .. n	variable	String	Reference to a variable from Flight Simulator 2024. Use prefix 'L:' for LVARS, see example below
2 .. n	unit	String	Unit of the variable, can be found with the variable. Different units can be used for different variables. For example Hours, Knots and RPM
last	callback_function	Function	The function to call when new data is available

Example

fs2024_variable_subscribe("INDICATED ALTITUDE", "Feet", function(ft)
    txt_set(alt, tostring(math.floor(ft)))
end)

fs2024_variable_write

Simulation Instrument Studio 1

Overloads

fs2024_variable_write(variable, unit, value)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	variable	String	Reference to a variable from Flight Simulator 2024
2	unit	String	Unit of the variable, can be found with the variable. Different units can be used for different variables. For example Hours, Knots and RPM.
3	value	Number	The value to be written

Example

-- Simulator value, not a panel value
fs2024_variable_write("INDICATED ALTITUDE", "Feet")

Photo slot: shots/fs2024_variable_write.png

fsx_connected

Simulation Instrument Studio 1

Overloads

fsx_connected()

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	connected	Boolean	True is connected, otherwise false

Example

-- Simulator value
fsx_connected("INDICATED ALTITUDE", "Feet")

fsx_event

Simulation Instrument Studio 1

Overloads

fsx_event(event,value)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	event	String	Reference to an event from Flight Simulator X or Prepar3D
2	value	Number	(Optional) Send a value with the event. Some events support setting a value.

Example

-- Simulator value
fsx_event("INDICATED ALTITUDE", "Feet")

fsx_variable_subscribe

Simulation Instrument Studio 1

Overloads

fsx_variable_subscribe(variable, unit, callback_function)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1 .. n	variable	String	Reference to a variable from Flight Simulator X or Prepar3D
2 .. n	unit	String	Unit of the variable, can be found with the variable. Different units can be used for different variables. For example Hours, Knots and RPM (look here for FSX units and here for Prepar3D)
last	callback_function	Function	The function to call when new data is available

Example

fsx_variable_subscribe("INDICATED ALTITUDE", "Feet", function(ft)
    txt_set(alt, tostring(math.floor(ft)))
end)

fsx_variable_write

Simulation Instrument Studio 1

Overloads

fsx_variable_write(variable, unit, value)

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	variable	String	Reference to a variable from Flight Simulator X or Prepar3D
2	unit	String	Unit of the variable, can be found with the variable. Different units can be used for different variables. For example Hours, Knots and RPM
3	value	Number	The value to be written

Example

-- Simulator value
fsx_variable_write("INDICATED ALTITUDE", "Feet")

Photo slot: shots/fsx_variable_write.png

p3d_connected

Simulation Instrument Studio 1

Overloads

p3d_connected()

A simulator call. Connection, variables, and events for that sim.

Parameters

#	Name	Type	Description
1	connected	Boolean	True is connected, otherwise false

Example

-- Simulator value
p3d_connected("INDICATED ALTITUDE", "Feet")