Command

The Command object represents a single command in the simulator. This object can be used to activate the command, and inspect some of its properties.

Command objects can be found using simulator.findCommand() or simulator.createCommand().

Properties

• Command.name is the name of this command.

Unfortunately, the description of the command isn't available to plugins.

Methods

• Command.once() activates this command once.
• Command.begin() begins activating this command.
• Command.end() ends activating this command.

Events

Listen to these events using simulator.addEventListener(). Remove your listener using simulator.removeEventListener().

• begin is fired when command activation begins.
• continue is fired when command activation continues.
• end is fired when command activation ends.

References

• XPLM's XPLMUtilities page comprehensively describes the behaviour of commands.