added documenation for BODYATMOSHPERE

KSP-KOS · Feb 13, 2023 · f5d39fe · f5d39fe
1 parent 9fab0b6
commit f5d39fe
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 7 deletions.
diff --git a/doc/source/changes.rst b/doc/source/changes.rst
@@ -66,6 +66,13 @@ Added :attr:`FileContent:BINARY` to let you read a binary
 file as a LIST of numbers 0-255 for the byte values in the
 file.  
 
+Function BODYATMOSPHERE
+:::::::::::::::::::::::
+
+Added :function:`BODYATMOSPHERE` as an alternate way to 
+obtain the atmosphere information about a body.  Actually
+this function had already existed.  It just hadn't been
+documented.
 
 Changes in 1.3
 --------------

diff --git a/doc/source/structures/celestial_bodies/atmosphere.rst b/doc/source/structures/celestial_bodies/atmosphere.rst
@@ -3,7 +3,27 @@
 Atmosphere
 ==========
 
-A Structure closely tied to :struct:`Body` A variable of type :struct:`Atmosphere` usually is obtained by the :attr:`:ATM <Body:ATM>` suffix of a :struct:`Body`. ALL The following values are read-only. You can't change the value of a body's atmosphere.
+A Structure closely tied to :struct:`Body`.  A variable of type :struct:`Atmosphere`
+contains information about the atmosphere (or lack of atmosphere) of a celestial body.
+
+A :struct:`Atmosphere` is usually is obtained by the :attr:`:ATM <Body:ATM>`
+suffix of a :struct:`Body`.
+
+A :struct:`Atmosphere` can also be obtained by using the following function:
+
+.. function:: BODYATMOSPHERE(name)
+
+Passing in a string (``name``) parameter, this function returns the
+:attr:`ATM <Body:ATM>` of the body that has that name.  It's identical
+to calling ``BODY(name):ATM``, but accomplishes the goal in fewer steps.
+
+It will crash with an error if no such body is found in the game.
+
+Structure
+---------
+
+ALL The following values are read-only. You
+can't change the value of a body's atmosphere.  
 
 .. structure:: Atmosphere
 

diff --git a/src/kOS.sln b/src/kOS.sln
@@ -15,16 +15,16 @@ Global
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{465EC87D-723D-4A6C-B116-9777AC641DE3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{465EC87D-723D-4A6C-B116-9777AC641DE3}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{465EC87D-723D-4A6C-B116-9777AC641DE3}.Debug|Any CPU.ActiveCfg = Release|Any CPU
+		{465EC87D-723D-4A6C-B116-9777AC641DE3}.Debug|Any CPU.Build.0 = Release|Any CPU
 		{465EC87D-723D-4A6C-B116-9777AC641DE3}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{465EC87D-723D-4A6C-B116-9777AC641DE3}.Release|Any CPU.Build.0 = Release|Any CPU
-		{590FFDA8-7B44-4BC3-A12A-5FFE2BB7D8FD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{590FFDA8-7B44-4BC3-A12A-5FFE2BB7D8FD}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{590FFDA8-7B44-4BC3-A12A-5FFE2BB7D8FD}.Debug|Any CPU.ActiveCfg = Release|Any CPU
+		{590FFDA8-7B44-4BC3-A12A-5FFE2BB7D8FD}.Debug|Any CPU.Build.0 = Release|Any CPU
 		{590FFDA8-7B44-4BC3-A12A-5FFE2BB7D8FD}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{590FFDA8-7B44-4BC3-A12A-5FFE2BB7D8FD}.Release|Any CPU.Build.0 = Release|Any CPU
-		{C9A42A44-DDC8-4D6C-8A16-D7F30F494B46}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{C9A42A44-DDC8-4D6C-8A16-D7F30F494B46}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C9A42A44-DDC8-4D6C-8A16-D7F30F494B46}.Debug|Any CPU.ActiveCfg = Release|Any CPU
+		{C9A42A44-DDC8-4D6C-8A16-D7F30F494B46}.Debug|Any CPU.Build.0 = Release|Any CPU
 		{C9A42A44-DDC8-4D6C-8A16-D7F30F494B46}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{C9A42A44-DDC8-4D6C-8A16-D7F30F494B46}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection