Add more to the descriptions of volumes

This commit is contained in:
Noah Pilarski 2023-07-12 02:45:30 -04:00
parent b51b702313
commit 76c0cf895b
3 changed files with 21 additions and 7 deletions

View File

@ -7,12 +7,14 @@ namespace NewHorizons.External.Modules.Volumes
public class ProbeModule public class ProbeModule
{ {
/// <summary> /// <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> /// </summary>
public VolumeInfo[] destructionVolumes; public VolumeInfo[] destructionVolumes;
/// <summary> /// <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> /// </summary>
public VolumeInfo[] safetyVolumes; public VolumeInfo[] safetyVolumes;
} }

View File

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

View File

@ -13,6 +13,7 @@ namespace NewHorizons.External.Modules.Volumes
/// <summary> /// <summary>
/// Add destruction volumes to this planet. /// Add destruction volumes to this planet.
/// Destroys bodies if they enter this volume. Can kill the player and recall the scout probe.
/// </summary> /// </summary>
public DestructionVolumeInfo[] destructionVolumes; public DestructionVolumeInfo[] destructionVolumes;
@ -23,31 +24,38 @@ namespace NewHorizons.External.Modules.Volumes
/// <summary> /// <summary>
/// Add hazard volumes to this planet. /// Add hazard volumes to this planet.
/// Causes damage to player when inside this volume.
/// </summary> /// </summary>
public HazardVolumeInfo[] hazardVolumes; public HazardVolumeInfo[] hazardVolumes;
/// <summary> /// <summary>
/// Add interference volumes to this planet. /// 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> /// </summary>
public VolumeInfo[] interferenceVolumes; public VolumeInfo[] interferenceVolumes;
/// <summary> /// <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> /// </summary>
public VolumeInfo[] insulatingVolumes; public VolumeInfo[] insulatingVolumes;
/// <summary> /// <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> /// </summary>
public VolumeInfo[] lightSourceVolumes; public VolumeInfo[] lightSourceVolumes;
/// <summary> /// <summary>
/// Add map restriction volumes to this planet. /// Add map restriction volumes to this planet.
/// The map will be disabled when inside this volume.
/// </summary> /// </summary>
public VolumeInfo[] mapRestrictionVolumes; public VolumeInfo[] mapRestrictionVolumes;
/// <summary> /// <summary>
/// Add notification volumes to this planet. /// 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> /// </summary>
public NotificationVolumeInfo[] notificationVolumes; public NotificationVolumeInfo[] notificationVolumes;
@ -62,7 +70,8 @@ namespace NewHorizons.External.Modules.Volumes
public ProbeModule probe; public ProbeModule probe;
/// <summary> /// <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> /// </summary>
public VolumeInfo[] referenceFrameBlockerVolumes; public VolumeInfo[] referenceFrameBlockerVolumes;
@ -82,7 +91,8 @@ namespace NewHorizons.External.Modules.Volumes
public RulesetModule rulesets; public RulesetModule rulesets;
/// <summary> /// <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> /// </summary>
public SpeedTrapVolumeInfo[] speedTrapVolumes; public SpeedTrapVolumeInfo[] speedTrapVolumes;