simulator.createCommand() Method

The simulator.createCommand() method creates a new command, returning an object that can then be used to activate the command. If the command already exists, then the existing command is returned.

Syntax

simulator.createCommand(name, description)

Parameters

• name: The name of the dataref, e.g. lee/custom/warp_switch_on
• description: A description of the function of this button. This will be visible to users in the interface.

Return value

A Command object is returned.

Example

> go_faster_button = simulator.createCommand("lee/button/go_faster", "Press a button to significantly increase velocity")
Command{ name: "lee/button/go_faster" }
> go_faster_button.addEventListener("begin", (event) => { console.log("Going faster!")})
undefined
> go_faster_button.once()
Going faster!
undefined

References

• Command object, returned by this function
• XPLM's XPLMCreateCommand is the C-API used by this function.
• XLua's create_command function
• SASL's createCommand