Dataref.set() Method

The Dataref.set() sets the value of a dataref. The new value is provided to the dataref's owner, which may or may not change the value of this dataref.

Syntax

Dataref.set(new_value)

Parameters

• new_value is the new value for the dataref. It should be a Number, String, or an Array of Numbers, depending on the type of the dataref.

Return value

This function has no return value.

Exceptions

• TypeError will be thrown if the wrong type is provided when setting a dataref.
• Error is thrown when trying to write a dataref that isn't writable.

Example

> dataref = simulator.findDataref("laminar/c172/fuel/fuel_tank_selector")
Dataref{ name: "laminar/c172/fuel/fuel_tank_selector" }
> dataref.set(1)
undefined
> dataref.set("banana")
Uncaught TypeError: Invalid value type
> dataref = simulator.findDataref("sim/version/xplane_internal_version")
Dataref{ name: "sim/version/xplane_internal_version" }
> dataref.set(121000)
Uncaught Error: Not writable

References

• XPLM's API for setting variables use more specific types:
  • Number values are set using:
    • XPLMSetDatad for double
    • XPLMSetDataf for float
    • XPLMSetDatai for int
  • Array values are set using:
    • XPLMSetDatavf for float arrays
    • XPLMSetDatavi for int arrays
  • String values are set using XPLMGetDatab; the string is encoded in UTF8.
• XLua's datarefs can be used as normal variables
• SASL's set