simulator.createDataref() Method

The simulator.createDataref() method creates a new dataref, returning an object that can then be used to manipulate the dataref.

Syntax

simulator.createDataref(name)

Parameters

• name: The name of the dataref, e.g. lee/custom/mach_number
• type: The dataref type can be one of number, array, or string.
• writable: A boolean, indicating if this dataref can only be read (false) or both read and written (true)
• value_func: A callback function that will provide a value for this dataref.

Return value

An OwnedDataref object is returned.

Example

> latitude_dr = simulator.createDataref("lee/custom/total_thrust", "number", false, () => {25000.0})
OwnedDataref{ name: "lee/custom/total_thrust", type: "number", writable: false }
> latitude_dr.value
25000.0

References

• OwnedDataref object, returned by this function
• XPLM's XPLMRegisterDataAccessor is the C-API used by this function.
• XLua's create_dataref function
• SASL's createGlobalProperty, and when to use it