Skip to content

Commit

Permalink
update help text and documentation
Browse files Browse the repository at this point in the history
JonnyOThan committed Sep 18, 2020
1 parent 49576f5 commit 1727529
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion KOS-Scansat/Addon.cs
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ private void InitializeSuffixes()
AddSuffix("COMPLETEDSCANS", new kOS.Safe.Encapsulation.Suffixes.TwoArgsSuffix<ListValue, BodyTarget, GeoCoordinates>(GetScans, "Returns the list of the completed scans of Body,GeoCoordinates"));
AddSuffix("ALLSCANTYPES", new kOS.Safe.Encapsulation.Suffixes.NoArgsSuffix<ListValue>(GetScanNames, "Names of all scan types"));
AddSuffix("ALLRESOURCES", new kOS.Safe.Encapsulation.Suffixes.NoArgsSuffix<ListValue>(GetResourceNames, "List of all activated resource in the current game"));
AddSuffix("RESOURCEAT", new kOS.Safe.Encapsulation.Suffixes.VarArgsSuffix<ScalarDoubleValue, Structure>(GetResourceByName, "Returns the amount of a resource by its scan type: Body,GeoCoordinates,scantype"));
AddSuffix("RESOURCEAT", new kOS.Safe.Encapsulation.Suffixes.VarArgsSuffix<ScalarDoubleValue, Structure>(GetResourceByName, "Returns the amount of a resource by its scan type: Body,GeoCoordinates,resourcename"));
AddSuffix("SLOPE", new kOS.Safe.Encapsulation.Suffixes.TwoArgsSuffix<ScalarDoubleValue, BodyTarget, GeoCoordinates>(GetSlope, "Returns the most accurate slope of the location"));
AddSuffix("GETCOVERAGE", new kOS.Safe.Encapsulation.Suffixes.TwoArgsSuffix<ScalarDoubleValue, BodyTarget, StringValue>(GetCoverage, "Returns completen percatage of a body,scantype"));
AddSuffix("GETANOMALIES", new kOS.Safe.Encapsulation.Suffixes.OneArgsSuffix<ListValue, BodyTarget>(GetAnomalies, "Returns a list of waypoints to anomalies on the given body"));
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -56,9 +56,9 @@ Returns the completed percentage of the scantype of the body.

Returns a list of the valid resources, which are known to scansat and activated by other mods

**:RESOURCEAT (\<body\>,\<geoposition\>,\<scantype\>)**
**:RESOURCEAT (\<body\>,\<geoposition\>,\<resourcename\>)**

Returns the value (as a double) of and given resource at the spot.
Returns the value (as a double) of and given resource at the spot. Returns -1 if the resource amount is not known.

**:GETANOMALIES (\<body\>)**

0 comments on commit 1727529

Please sign in to comment.