xplane v0.2.0 XPlane.CmdRef

Represent an X-Plane Command Reference and provide helper methods to load the closest available set of Command References for a given X-Plane version.

Note the X-Plane config file these come from is Commands.txt, I’ve named this module CmdRef to mirror DataRef/Data distinction.

Link to this section Summary

Functions

Load the closest list of CmdRefs we have available for the specified X-Plane version

Link to this section Types

Link to this type t()
t() :: %XPlane.CmdRef{description: String.t(), name: String.t()}

Link to this section Functions

Link to this function describe(cmds, pattern)
Link to this function load_version(version_number)
load_version(integer()) :: %{atom: XPlane.CmdRef.t()}

Load the closest list of CmdRefs we have available for the specified X-Plane version.

Parameters