Xpl dataref write

From Sim Innovations Wiki
Jump to navigation Jump to search

Description

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

xpl_dataref_write is used write a dataref to X-plane.

X-plane used the following datarefs, these may be to write values to. X-plane DataRefs

Return value

This function won't return any value.

Arguments

# Argument Type Description
1 dataref String Reference to a dataref from X-plane (see [1])
2 type Number Data type of the DataRef, can be INT, FLOAT, DOUBLE, BYTE, STRING, INT[n], FLOAT[n], DOUBLE[n] or BYTE[n] (see X-plane DataRefs)
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, available from AM 2.1.1. Enabling this feature will make AM write the dataref every simulator frame. Make sure to disable the forcing again at some point in your code!

Example

-- Write 99 to dataref "sim/cockpit2/radios/actuators/com1_standby_frequency_hz"
xpl_dataref_write("sim/cockpit2/radios/actuators/com1_standby_frequency_hz", "INT", 99)

-- Write 4 values to array dataref "sim/cockpit/switches/anti_ice_inlet_heat_per_enigne".
xpl_dataref_write("sim/cockpit/switches/anti_ice_inlet_heat_per_enigne", "INT[8]", {1, 1, 0, 1})

-- Write 4 values to array dataref with an offset "sim/aircraft/panel/acf_ins_size". Using an offset. [10]=0.1 , [11]=0.2, [12]=0.3, [13]=0.4
xpl_dataref_write("sim/aircraft/panel/acf_ins_size", "FLOAT[200]", {0.1, 0.2, 0.3, 0.4}, 9)