Add more to the descriptions of volumes (#634)

## Improvements
- Added more to the descriptions of volumes

NewHorizons/Builder/Volumes/VanishVolumeBuilder.cs

@@ -26,7 +26,7 @@ namespace NewHorizons.Builder.Volumes
 
             volume._collider = collider;
             volume._shrinkBodies = info.shrinkBodies;
-            volume._onlyAffectsPlayerAndShip = info.onlyAffectsPlayerAndShip;
+            volume._onlyAffectsPlayerAndShip = info.onlyAffectsPlayerRelatedBodies;
 
             go.SetActive(true);
 

NewHorizons/External/Configs/PlanetConfig.cs

@@ -217,7 +217,7 @@ namespace NewHorizons.External.Configs
             if (Base.centerOfSolarSystem) Orbit.isStatic = true;
             if (Atmosphere?.clouds?.lightningGradient != null) Atmosphere.clouds.hasLightning = true;
             if (Bramble?.dimension != null && Orbit?.staticPosition == null) throw new Exception($"Dimension {name} must have Orbit.staticPosition defined.");
-            if (Bramble?.dimension != null) canShowOnTitle = false; 
+            if (Bramble?.dimension != null) canShowOnTitle = false;
             if (Orbit?.staticPosition != null) Orbit.isStatic = true;
 
             // For each quantum group, verify the following:
@@ -463,7 +463,7 @@ namespace NewHorizons.External.Configs
                     if (ring.curve != null) ring.scaleCurve = ring.curve;
                 }
             }
-            
+
             if (Base.zeroGravityRadius != 0f)
             {
                 Volumes ??= new VolumesModule();
@@ -616,6 +616,14 @@ namespace NewHorizons.External.Configs
                     CometTail.rotationOverride = Base.cometTailRotation;
                 }
             }
+
+            if (Volumes?.destructionVolumes != null)
+            {
+                foreach (var destructionVolume in Volumes.destructionVolumes)
+                {
+                    if (destructionVolume.onlyAffectsPlayerAndShip) destructionVolume.onlyAffectsPlayerRelatedBodies = true;
+                }
+            }
         }
         #endregion
     }

NewHorizons/External/Modules/Volumes/ProbeModule.cs

@@ -7,12 +7,14 @@ namespace NewHorizons.External.Modules.Volumes
     public class ProbeModule
     {
         /// <summary>
-        /// Add probe destruction volumes to this planet. These will delete your probe.
+        /// Add probe destruction volumes to this planet.
+        /// These will delete your probe just like the eye of the universe does.
         /// </summary>
         public VolumeInfo[] destructionVolumes;
 
         /// <summary>
-        /// Add probe safety volumes to this planet. These will stop the probe destruction volumes from working.
+        /// Add probe safety volumes to this planet.
+        /// These will stop the probe destruction volumes from working.
         /// </summary>
         public VolumeInfo[] safetyVolumes;
     }

NewHorizons/External/Modules/Volumes/RulesetModule.cs

@@ -9,10 +9,12 @@ namespace NewHorizons.External.Modules.Volumes
     {
         /// <summary>
         /// Add anti travel music rulesets to this planet.
+        /// This means no space/traveling music while inside the ruleset/volume.
+        /// Usually used on planets.
         /// </summary>
         public VolumeInfo[] antiTravelMusicRulesets;
         /// <summary>
-        /// Add player impact rulesets to this planet.
+        /// Add player impact rulesets to this planet. 
         /// </summary>
         public PlayerImpactRulesetInfo[] playerImpactRulesets;
         /// <summary>

NewHorizons/External/Modules/Volumes/VolumeInfos/VanishVolumeInfo.cs

@@ -1,4 +1,5 @@
 using Newtonsoft.Json;
+using System;
 using System.ComponentModel;
 
 namespace NewHorizons.External.Modules.Volumes.VolumeInfos
@@ -12,9 +13,11 @@ namespace NewHorizons.External.Modules.Volumes.VolumeInfos
         [DefaultValue(true)] public bool shrinkBodies = true;
 
         /// <summary>
-        /// Whether this volume only affects the player and ship.
+        /// Whether this volume only affects the player, ship, probe/scout, model rocket ship, and nomai shuttle.
         /// </summary>
-        public bool onlyAffectsPlayerAndShip;
+        public bool onlyAffectsPlayerRelatedBodies;
+
+        [Obsolete] public bool onlyAffectsPlayerAndShip;
     }
 
 }

NewHorizons/External/Modules/Volumes/VolumesModule.cs

@@ -13,6 +13,7 @@ namespace NewHorizons.External.Modules.Volumes
 
         /// <summary>
         /// Add destruction volumes to this planet.
+        /// Destroys bodies if they enter this volume. Can kill the player and recall the scout probe.
         /// </summary>
         public DestructionVolumeInfo[] destructionVolumes;
 
@@ -23,31 +24,38 @@ namespace NewHorizons.External.Modules.Volumes
 
         /// <summary>
         /// Add hazard volumes to this planet.
+        /// Causes damage to player when inside this volume.
         /// </summary>
         public HazardVolumeInfo[] hazardVolumes;
 
         /// <summary>
         /// Add interference volumes to this planet.
+        /// Hides HUD markers of ship scout/probe and prevents scout photos if you are not inside the volume together with ship or scout probe.
         /// </summary>
         public VolumeInfo[] interferenceVolumes;
 
         /// <summary>
-        /// Add insulating volumes to this planet. These will stop electricty hazard volumes from affecting you (just like the jellyfish).
+        /// Add insulating volumes to this planet.
+        /// These will stop electricty hazard volumes from affecting you (just like the jellyfish).
         /// </summary>
         public VolumeInfo[] insulatingVolumes;
 
         /// <summary>
-        /// Add light source volumes to this planet. These will activate rafts and other light detectors.
+        /// Add light source volumes to this planet.
+        /// These will activate rafts and other light detectors.
         /// </summary>
         public VolumeInfo[] lightSourceVolumes;
 
         /// <summary>
         /// Add map restriction volumes to this planet.
+        /// The map will be disabled when inside this volume.
         /// </summary>
         public VolumeInfo[] mapRestrictionVolumes;
 
         /// <summary>
         /// Add notification volumes to this planet.
+        /// Sends a notification to the player just like ghost matter does when you get too close
+        /// and also to the ship just like when you damage a component on the ship.
         /// </summary>
         public NotificationVolumeInfo[] notificationVolumes;
 
@@ -62,7 +70,8 @@ namespace NewHorizons.External.Modules.Volumes
         public ProbeModule probe;
 
         /// <summary>
-        /// Add reference frame blocker volumes to this planet. These will stop the player from seeing/targeting any reference frames.
+        /// Add reference frame blocker volumes to this planet.
+        /// These will stop the player from seeing/targeting any reference frames.
         /// </summary>
         public VolumeInfo[] referenceFrameBlockerVolumes;
 
@@ -82,7 +91,8 @@ namespace NewHorizons.External.Modules.Volumes
         public RulesetModule rulesets;
 
         /// <summary>
-        /// Add speed trap volumes to this planet. Slows down the player when they enter this volume.
+        /// Add speed trap volumes to this planet.
+        /// Slows down the player when they enter this volume.
         /// </summary>
         public SpeedTrapVolumeInfo[] speedTrapVolumes;
 

NewHorizons/Schemas/body_schema.json

@@ -3263,7 +3263,7 @@
         },
         "destructionVolumes": {
           "type": "array",
-          "description": "Add destruction volumes to this planet.",
+          "description": "Add destruction volumes to this planet.\nDestroys bodies if they enter this volume. Can kill the player and recall the scout probe.",
           "items": {
             "$ref": "#/definitions/DestructionVolumeInfo"
           }
@@ -3277,42 +3277,42 @@
         },
         "hazardVolumes": {
           "type": "array",
-          "description": "Add hazard volumes to this planet.",
+          "description": "Add hazard volumes to this planet.\nCauses damage to player when inside this volume.",
           "items": {
             "$ref": "#/definitions/HazardVolumeInfo"
           }
         },
         "interferenceVolumes": {
           "type": "array",
-          "description": "Add interference volumes to this planet.",
+          "description": "Add interference volumes to this planet.\nHides HUD markers of ship scout/probe and prevents scout photos if you are not inside the volume together with ship or scout probe.",
           "items": {
             "$ref": "#/definitions/VolumeInfo"
           }
         },
         "insulatingVolumes": {
           "type": "array",
-          "description": "Add insulating volumes to this planet. These will stop electricty hazard volumes from affecting you (just like the jellyfish).",
+          "description": "Add insulating volumes to this planet.\nThese will stop electricty hazard volumes from affecting you (just like the jellyfish).",
           "items": {
             "$ref": "#/definitions/VolumeInfo"
           }
         },
         "lightSourceVolumes": {
           "type": "array",
-          "description": "Add light source volumes to this planet. These will activate rafts and other light detectors.",
+          "description": "Add light source volumes to this planet.\nThese will activate rafts and other light detectors.",
           "items": {
             "$ref": "#/definitions/VolumeInfo"
           }
         },
         "mapRestrictionVolumes": {
           "type": "array",
-          "description": "Add map restriction volumes to this planet.",
+          "description": "Add map restriction volumes to this planet.\nThe map will be disabled when inside this volume.",
           "items": {
             "$ref": "#/definitions/VolumeInfo"
           }
         },
         "notificationVolumes": {
           "type": "array",
-          "description": "Add notification volumes to this planet.",
+          "description": "Add notification volumes to this planet.\nSends a notification to the player just like ghost matter does when you get too close\nand also to the ship just like when you damage a component on the ship.",
           "items": {
             "$ref": "#/definitions/NotificationVolumeInfo"
           }
@@ -3330,7 +3330,7 @@
         },
         "referenceFrameBlockerVolumes": {
           "type": "array",
-          "description": "Add reference frame blocker volumes to this planet. These will stop the player from seeing/targeting any reference frames.",
+          "description": "Add reference frame blocker volumes to this planet.\nThese will stop the player from seeing/targeting any reference frames.",
           "items": {
             "$ref": "#/definitions/VolumeInfo"
           }
@@ -3355,7 +3355,7 @@
         },
         "speedTrapVolumes": {
           "type": "array",
-          "description": "Add speed trap volumes to this planet. Slows down the player when they enter this volume.",
+          "description": "Add speed trap volumes to this planet.\nSlows down the player when they enter this volume.",
           "items": {
             "$ref": "#/definitions/SpeedTrapVolumeInfo"
           }
@@ -3494,9 +3494,9 @@
           "description": "Whether the bodies will shrink when they enter this volume or just disappear instantly.",
           "default": true
         },
-        "onlyAffectsPlayerAndShip": {
+        "onlyAffectsPlayerRelatedBodies": {
           "type": "boolean",
-          "description": "Whether this volume only affects the player and ship."
+          "description": "Whether this volume only affects the player, ship, probe/scout, model rocket ship, and nomai shuttle."
         },
         "radius": {
           "type": "number",
@@ -3859,14 +3859,14 @@
       "properties": {
         "destructionVolumes": {
           "type": "array",
-          "description": "Add probe destruction volumes to this planet. These will delete your probe.",
+          "description": "Add probe destruction volumes to this planet.\nThese will delete your probe just like the eye of the universe does.",
           "items": {
             "$ref": "#/definitions/VolumeInfo"
           }
         },
         "safetyVolumes": {
           "type": "array",
-          "description": "Add probe safety volumes to this planet. These will stop the probe destruction volumes from working.",
+          "description": "Add probe safety volumes to this planet.\nThese will stop the probe destruction volumes from working.",
           "items": {
             "$ref": "#/definitions/VolumeInfo"
           }
@@ -3968,14 +3968,14 @@
       "properties": {
         "antiTravelMusicRulesets": {
           "type": "array",
-          "description": "Add anti travel music rulesets to this planet.",
+          "description": "Add anti travel music rulesets to this planet.\nThis means no space/traveling music while inside the ruleset/volume.\nUsually used on planets.",
           "items": {
             "$ref": "#/definitions/VolumeInfo"
           }
         },
         "playerImpactRulesets": {
           "type": "array",
-          "description": "Add player impact rulesets to this planet.",
+          "description": "Add player impact rulesets to this planet. ",
           "items": {
             "$ref": "#/definitions/PlayerImpactRulesetInfo"
           }