Navigation Database Access

This returns the very first navaid in the database. Use this to traverse the entire database. Returns XPLM_NAV_NOT_FOUND if the nav database is empty.

-- returns XPLMNavRef -> assign to local/var
local my_navRef = XPLMGetFirstNavAid(
)

Given a valid navaid ref, this routine returns the next navaid. It returns XPLM_NAV_NOT_FOUND if the navaid passed in was invalid or if the navaid passed in was the last one in the database. Use this routine to iterate across all like-typed navaids or the entire database.

-- returns XPLMNavRef -> assign to local/var
local my_navRef = XPLMGetNextNavAid(
    inNavAidRef     -- XPLMNavRef
)

See associated types:

• XPLMNavRef

This routine returns the ref of the first navaid of the given type in the database or XPLM_NAV_NOT_FOUND if there are no navaids of that type in the database. You must pass exactly one navaid type to this routine.

-- returns XPLMNavRef -> assign to local/var
local my_navRef = XPLMFindFirstNavAidOfType(
    inType     -- XPLMNavType
)

See associated types:

• XPLMNavType

This routine returns the ref of the last navaid of the given type in the database or XPLM_NAV_NOT_FOUND if there are no navaids of that type in the database. You must pass exactly one navaid type to this routine.

-- returns XPLMNavRef -> assign to local/var
local my_navRef = XPLMFindLastNavAidOfType(
    inType     -- XPLMNavType
)

See associated types:

• XPLMNavType

This routine provides a number of searching capabilities for the nav database. XPLMFindNavAid will search through every navaid whose type is within inType (multiple types may be added together) and return any navaids found based on the following rules:

• If inLat and inLon are not NULL, the navaid nearest to that lat/lon will be returned, otherwise the last navaid found will be returned.

• If inFrequency is not NULL, then any navaids considered must match this frequency. Note that this will screen out radio beacons that do not have frequency data published (like inner markers) but not fixes and airports.

• If inNameFragment is not NULL, only navaids that contain the fragment in their name will be returned.

• If inIDFragment is not NULL, only navaids that contain the fragment in their IDs will be returned.

This routine provides a simple way to do a number of useful searches: * Find the nearest navaid on this frequency. * Find the nearest airport. * Find the VOR whose ID is "BOS". * Find the nearest airport whose name contains "Chicago".

-- returns XPLMNavRef -> assign to local/var
local my_navRef = XPLMFindNavAid(
    inNameFragment,    -- string
    inIDFragment,      -- string
    inLat,             -- float
    inLon,             -- float
    inFrequency,       -- int
    inType             -- XPLMNavType
)

See associated types:

• XPLMNavType

This routine returns information about a navaid. Any non-null field is filled out with information if it is available.

Frequencies are in the nav.dat convention as described in the X-Plane nav database FAQ: NDB frequencies are exact, all others are multiplied by 100.

The buffer for IDs should be at least 6 chars and the buffer for names should be at least 41 chars, but since these values are likely to go up, I recommend passing at least 32 chars for IDs and 256 chars for names when possible.

The outReg parameter tells if the navaid is within the local "region" of loaded DSFs. (This information may not be particularly useful to plugins.) The parameter is a single byte value 1 for true or 0 for false, not a C string.

XPLMGetNavAidInfo(
    inRef,           -- XPLMNavRef
    outType,         -- XPLMNavType
    outLatitude,     -- float
    outLongitude,    -- float
    outHeight,       -- float
    outFrequency,    -- int
    outHeading,      -- float
    outID,           -- char
    outName,         -- char
    outReg           -- char
)

See associated types:

• XPLMNavRef
• XPLMNavType