weyne/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2026-08-19 13:46:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

UPDATE: NAVIGATION function params

Browse Source 
- Added (Optional) to param descriptions for params that have default values
This commit is contained in:
Rolln-dev
2026-03-02 08:12:03 -07:00
parent 6f16d34681
commit 414a1d2ca5
4 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Moose Development/Moose/Navigation/Beacons.lua
+1 -1
View File
@@ -242,7 +242,7 @@ end
--- Find closest beacons to a given coordinate. --- Find closest beacons to a given coordinate.
-- @param #BEACONS self -- @param #BEACONS self
-- @param Core.Point#COORDINATE Coordinate The reference coordinate. -- @param Core.Point#COORDINATE Coordinate The reference coordinate.
-- @param #number Nmax Max number of beacons. Default 5. -- @param #number Nmax (Optional) Max number of beacons. Default 5.
-- @param #number TypeID (Optional) Only search for specific beacon types, *e.g.* `BEACON.Type.TACAN`. -- @param #number TypeID (Optional) Only search for specific beacon types, *e.g.* `BEACON.Type.TACAN`.
-- @param #number DistMax (Optional) Max search distance in meters. -- @param #number DistMax (Optional) Max search distance in meters.
-- @return #table Table of #BEACONS.Beacon closest beacons. -- @return #table Table of #BEACONS.Beacon closest beacons.
Moose Development/Moose/Navigation/Point.lua
+6 -6
View File
@@ -115,7 +115,7 @@ NAVFIX.version="0.1.0"
--- Create a new NAVFIX class instance from a given VECTOR. --- Create a new NAVFIX class instance from a given VECTOR.
-- @param #NAVFIX self -- @param #NAVFIX self
-- @param #string Name Name/ident of the point. Should be unique! -- @param #string Name Name/ident of the point. Should be unique!
-- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`. -- @param #string Type (Optional) Type of the point. Default `NAVFIX.Type.POINT`.
-- @param Core.Vector#VECTOR Vector Position vector of the navpoint. -- @param Core.Vector#VECTOR Vector Position vector of the navpoint.
-- @return #NAVFIX self -- @return #NAVFIX self
function NAVFIX:NewFromVector(Name, Type, Vector) function NAVFIX:NewFromVector(Name, Type, Vector)
@@ -150,7 +150,7 @@ end
--- Create a new NAVFIX class instance from a given COORDINATE. --- Create a new NAVFIX class instance from a given COORDINATE.
-- @param #NAVFIX self -- @param #NAVFIX self
-- @param #string Name Name of the fix. Should be unique! -- @param #string Name Name of the fix. Should be unique!
-- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`. -- @param #string Type (Optional) Type of the point. Default `NAVFIX.Type.POINT`.
-- @param Core.Point#COORDINATE Coordinate Coordinate of the point. -- @param Core.Point#COORDINATE Coordinate Coordinate of the point.
-- @return #NAVFIX self -- @return #NAVFIX self
function NAVFIX:NewFromCoordinate(Name, Type, Coordinate) function NAVFIX:NewFromCoordinate(Name, Type, Coordinate)
@@ -168,7 +168,7 @@ end
--- Create a new NAVFIX instance from given latitude and longitude in degrees, minutes and seconds (DMS). --- Create a new NAVFIX instance from given latitude and longitude in degrees, minutes and seconds (DMS).
-- @param #NAVFIX self -- @param #NAVFIX self
-- @param #string Name Name of the fix. Should be unique! -- @param #string Name Name of the fix. Should be unique!
-- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`. -- @param #string Type (Optional) Type of the point. Default `NAVFIX.Type.POINT`.
-- @param #string Latitude Latitude in DMS as string. -- @param #string Latitude Latitude in DMS as string.
-- @param #string Longitude Longitude in DMS as string. -- @param #string Longitude Longitude in DMS as string.
-- @return #NAVFIX self -- @return #NAVFIX self
@@ -186,7 +186,7 @@ end
--- Create a new NAVFIX instance from given latitude and longitude in decimal degrees (DD). --- Create a new NAVFIX instance from given latitude and longitude in decimal degrees (DD).
-- @param #NAVFIX self -- @param #NAVFIX self
-- @param #string Name Name of the fix. Should be unique! -- @param #string Name Name of the fix. Should be unique!
-- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`. -- @param #string Type (Optional) Type of the point. Default `NAVFIX.Type.POINT`.
-- @param #number Latitude Latitude in DD. -- @param #number Latitude Latitude in DD.
-- @param #number Longitude Longitude in DD. -- @param #number Longitude Longitude in DD.
-- @return #NAVFIX self -- @return #NAVFIX self
@@ -523,7 +523,7 @@ NAVAID.version="0.1.0"
--- Create a new NAVAID class instance. --- Create a new NAVAID class instance.
-- @param #NAVAID self -- @param #NAVAID self
-- @param #string Name Name/ident of this navaid. -- @param #string Name Name/ident of this navaid.
-- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`. -- @param #string Type (Optional) Type of the point. Default `NAVFIX.Type.POINT`.
-- @param #string ZoneName Name of the zone to scan the scenery. -- @param #string ZoneName Name of the zone to scan the scenery.
-- @param #string SceneryName Name of the scenery object. -- @param #string SceneryName Name of the scenery object.
-- @return #NAVAID self -- @return #NAVAID self
@@ -579,7 +579,7 @@ end
--- Set channel of, *e.g.*, TACAN beacons. --- Set channel of, *e.g.*, TACAN beacons.
-- @param #NAVAID self -- @param #NAVAID self
-- @param #number Channel The channel. -- @param #number Channel The channel.
-- @param #string Band The band either `"X"` (default) or `"Y"`. -- @param #string Band (Optional) The band either `"X"` (default) or `"Y"`.
-- @return #NAVAID self -- @return #NAVAID self
function NAVAID:SetChannel(Channel, Band) function NAVAID:SetChannel(Channel, Band)
Moose Development/Moose/Navigation/Radios.lua
+1 -1
View File
@@ -249,7 +249,7 @@ end
--- Find closest radios to a given coordinate. --- Find closest radios to a given coordinate.
-- @param #RADIOS self -- @param #RADIOS self
-- @param Core.Point#COORDINATE Coordinate The reference coordinate. -- @param Core.Point#COORDINATE Coordinate The reference coordinate.
-- @param #number Nmax Max number of radios. Default 5. -- @param #number Nmax (Optional) Max number of radios. Default 5.
-- @param #number DistMax (Optional) Max search distance in meters. -- @param #number DistMax (Optional) Max search distance in meters.
-- @return #table Table of #RADIOS.Radio closest radios. -- @return #table Table of #RADIOS.Radio closest radios.
function RADIOS:GetClosestRadios(Coordinate, Nmax, DistMax) function RADIOS:GetClosestRadios(Coordinate, Nmax, DistMax)
Moose Development/Moose/Navigation/Towns.lua
+1 -1
View File
@@ -240,7 +240,7 @@ end
--- Find closest towns to a given coordinate. --- Find closest towns to a given coordinate.
-- @param #TOWNS self -- @param #TOWNS self
-- @param Core.Point#COORDINATE Coordinate The reference coordinate. -- @param Core.Point#COORDINATE Coordinate The reference coordinate.
-- @param #number Nmax Max number of towns. Default 5. -- @param #number Nmax (Optional) Max number of towns. Default 5.
-- @param #number DistMax (Optional) Max search distance in meters. -- @param #number DistMax (Optional) Max search distance in meters.
-- @return #table Table of #TOWNS.Town closest towns. -- @return #table Table of #TOWNS.Town closest towns.
function TOWNS:GetClosestTowns(Coordinate, Nmax, DistMax) function TOWNS:GetClosestTowns(Coordinate, Nmax, DistMax)