2
0
mirror of https://github.com/9ParsonsB/Pulsar.git synced 2025-07-03 01:03:41 -04:00

Added framework xml documentation for all "exploration" events.

This commit is contained in:
Xjph
2022-06-12 14:44:04 -02:30
parent 9586e37be7
commit 0c218ed52b
17 changed files with 782 additions and 4 deletions

View File

@ -2,20 +2,38 @@
namespace Observatory.Framework.Files.Journal
{
/// <summary>
/// Event generated when a body surface scan is completed.
/// </summary>
public class SAAScanComplete : JournalBase
{
/// <summary>
/// Unique ID of current system.
/// </summary>
public ulong SystemAddress { get; init; }
/// <summary>
/// Name of the scanned body.
/// </summary>
public string BodyName { get; init; }
/// <summary>
/// ID of the scanned body within the system.
/// </summary>
public int BodyID { get; init; }
/// <summary>
/// This property is indicated with strikethrough in Frontier's documentation and may be deprecated.
/// This property is indicated with strikethrough in Frontier's documentation and is likely unused.
/// </summary>
public ImmutableList<string> Discoverers { get; init; }
/// <summary>
/// This property is indicated with strikethrough in Frontier's documentation and may be deprecated.
/// This property is indicated with strikethrough in Frontier's documentation and is likely unused.
/// </summary>
public ImmutableList<string> Mappers { get; init; }
/// <summary>
/// Number of probes fired to complete the surface scan.
/// </summary>
public int ProbesUsed { get; init; }
/// <summary>
/// Maximum number of probes which can be used to get efficiency bonus.
/// </summary>
public int EfficiencyTarget { get; init; }
}
}