diff --git a/ObservatoryFramework/Files/Journal/Exploration/BuyExplorationData.cs b/ObservatoryFramework/Files/Journal/Exploration/BuyExplorationData.cs index a5ff6ec..407e2cb 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/BuyExplorationData.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/BuyExplorationData.cs @@ -1,8 +1,17 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Journal event generated when buying system data from the galaxy map while docked. + /// public class BuyExplorationData : JournalBase { + /// + /// Name of the system for which data was purchased. + /// public string System { get; init; } + /// + /// Amount paid for the data. + /// public int Cost { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/CodexEntry.cs b/ObservatoryFramework/Files/Journal/Exploration/CodexEntry.cs index b44887e..3d8b207 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/CodexEntry.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/CodexEntry.cs @@ -2,27 +2,90 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when an item in the codex is scanned. + /// public class CodexEntry : JournalBase { + /// + /// Unique ID of the entry. + /// public ulong EntryID { get; init; } + /// + /// Name of the item scanned. + /// public string Name { get; init; } + /// + /// Localised name of the item scanned. + /// public string Name_Localised { get; init; } + /// + /// Codex sub category of the item scanned. + /// public string SubCategory { get; init; } + /// + /// Localised sub category name of the item scanned. + /// public string SubCategory_Localised { get; init; } + /// + /// Codex category of the item scanned. + /// public string Category { get; init; } + /// + /// Localised category name of the item scanned. + /// public string Category_Localised { get; init; } + /// + /// Codex region the scan occured in. + /// public string Region { get; init; } + /// + /// Localised name of the region. + /// public string Region_Localised { get; init; } + /// + /// Name of the system in which the scan occured. + /// public string System { get; init; } + /// + /// Unique ID of the system in which the scan occured. + /// public ulong SystemAddress { get; init; } + /// + /// Name of the nearest surface signal. + /// public string NearestDestination { get; init; } + /// + /// Localised name of hte nearest surface signal. + /// public string NearestDestination_Localised { get; init; } + /// + /// Indicator that this codex entry hasn't been previously scanned by the CMDR. + /// public bool IsNewEntry { get; init; } + /// + /// Indicator that htis codex entry has a trait not previously seen by the CMDR. + /// public bool NewTraitsDiscovered { get; init; } + /// + /// List of trais of the scanned item. + /// public ImmutableList Traits { get; init; } + /// + /// Value of the codex entry when sold to Universal Cartographics. + /// public int VoucherAmount { get; init; } + /// + /// Surface latitude where the scan occured. + /// public float Latitude { get; init; } + /// + /// Surface longitude where the scan occured. + /// public float Longitude { get; init; } + /// + /// Body ID of the system body where the scan occured. + /// public int BodyID { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/DiscoveryScan.cs b/ObservatoryFramework/Files/Journal/Exploration/DiscoveryScan.cs index c997b3a..ef13be3 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/DiscoveryScan.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/DiscoveryScan.cs @@ -1,8 +1,17 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when using the discovery scanner (honk) to initially scan system. No longer used in live game client, will be found only in historical data. + /// public class DiscoveryScan : JournalBase { + /// + /// Unique ID of system. + /// public ulong SystemAddress { get; init; } + /// + /// Number of bodies in system. + /// public int Bodies { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/FSSAllBodiesFound.cs b/ObservatoryFramework/Files/Journal/Exploration/FSSAllBodiesFound.cs index 8fb04d9..40d30ef 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/FSSAllBodiesFound.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/FSSAllBodiesFound.cs @@ -1,9 +1,21 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when all bodies within a system have been scanned. + /// public class FSSAllBodiesFound : JournalBase { + /// + /// Name of the system. + /// public string SystemName { get; init; } + /// + /// Unique ID of the system. + /// public ulong SystemAddress { get; init; } + /// + /// Count of all scanned bodies in system. + /// public int Count { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/FSSBodySignals.cs b/ObservatoryFramework/Files/Journal/Exploration/FSSBodySignals.cs index faa6e26..0cd3f45 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/FSSBodySignals.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/FSSBodySignals.cs @@ -1,5 +1,8 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when the full spectrum scanner finds surface signals on a body. + /// public class FSSBodySignals : SAASignalsFound { } diff --git a/ObservatoryFramework/Files/Journal/Exploration/FSSDiscoveryScan.cs b/ObservatoryFramework/Files/Journal/Exploration/FSSDiscoveryScan.cs index f7fd6af..887e6dc 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/FSSDiscoveryScan.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/FSSDiscoveryScan.cs @@ -1,11 +1,29 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when using the discovery scanner (honk) to initially scan system. + /// public class FSSDiscoveryScan : JournalBase { + /// + /// Name of the current system. + /// public string SystemName { get; init; } + /// + /// Unique ID of the current system. + /// public ulong SystemAddress { get; init; } + /// + /// Percentage of current system already scanned. + /// public float Progress { get; init; } + /// + /// Number of scannable bodies in system. + /// public int BodyCount { get; init; } + /// + /// Number of scannable non-body locations in system. + /// public int NonBodyCount { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/FSSSignalDiscovered.cs b/ObservatoryFramework/Files/Journal/Exploration/FSSSignalDiscovered.cs index 49116f3..2ced548 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/FSSSignalDiscovered.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/FSSSignalDiscovered.cs @@ -1,18 +1,57 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when a signal source is identified or scanned. + /// public class FSSSignalDiscovered : JournalBase { + /// + /// Name of the signal type. + /// public string SignalName { get; init; } + /// + /// Localised name of the signal type. + /// public string SignalName_Localised { get; init; } + /// + /// Faction state or circumstance that caused this signal to appear. + /// public string SpawningState { get; init; } + /// + /// Localised description of spawning state. + /// public string SpawningState_Localised { get; init; } + /// + /// Faction name which is associated with this signal. + /// public string SpawningFaction { get; init; } + /// + /// Localised name of the associated faction. + /// public string SpawningFaction_Localised { get; init; } + /// + /// Time until the signal despawns, in seconds. + /// public float TimeRemaining { get; init; } + /// + /// Unique ID of current system. + /// public ulong SystemAddress { get; init; } + /// + /// Numeric representation of the signal threat level. + /// public int ThreatLevel { get; init; } + /// + /// Type of signal. + /// public string USSType { get; init; } + /// + /// Localised name of signal type. + /// public string USSType_Localised { get; init; } + /// + /// Indicator if the signal is a station which can be docked with. + /// public bool IsStation { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/MaterialCollected.cs b/ObservatoryFramework/Files/Journal/Exploration/MaterialCollected.cs index 81663e7..f153100 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/MaterialCollected.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/MaterialCollected.cs @@ -1,10 +1,25 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when a material resource is collected. + /// public class MaterialCollected : JournalBase { + /// + /// Category to which the material belongs. + /// public string Category { get; init; } + /// + /// Name of the material. + /// public string Name { get; init; } + /// + /// Localised name of the material. + /// public string Name_Localised { get; init; } + /// + /// Count of the material. + /// public int Count { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/MaterialDiscarded.cs b/ObservatoryFramework/Files/Journal/Exploration/MaterialDiscarded.cs index dc3e885..5622301 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/MaterialDiscarded.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/MaterialDiscarded.cs @@ -1,5 +1,8 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when discarding held material resources. + /// public class MaterialDiscarded : MaterialCollected { } diff --git a/ObservatoryFramework/Files/Journal/Exploration/MaterialDiscovered.cs b/ObservatoryFramework/Files/Journal/Exploration/MaterialDiscovered.cs index b207f30..da8d0d7 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/MaterialDiscovered.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/MaterialDiscovered.cs @@ -1,10 +1,25 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated the first time a CMDR finds a particular material resource. + /// public class MaterialDiscovered : JournalBase { + /// + /// Category of the material. + /// public string Category { get; init; } + /// + /// Name of the material. + /// public string Name { get; init; } + /// + /// Localised name of the material. + /// public string Name_Localised { get; init; } + /// + /// Count of the number of discovered items in that category by the CMDR. + /// public int DiscoveryNumber { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/MultiSellExplorationData.cs b/ObservatoryFramework/Files/Journal/Exploration/MultiSellExplorationData.cs index bb08c64..e3943cd 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/MultiSellExplorationData.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/MultiSellExplorationData.cs @@ -3,11 +3,26 @@ using System.Collections.Immutable; namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when discovery data for multiple systems are sold at once. + /// public class MultiSellExplorationData : JournalBase { + /// + /// List of all sold first discoveries. + /// public ImmutableList Discovered { get; init; } + /// + /// Base value of total sold data. + /// public long BaseValue { get; init; } + /// + /// Bonus value added to base amount. + /// public long Bonus { get; init; } + /// + /// Total amount earned by CMDR for data sale. + /// public long TotalEarnings { get; init; } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/NavBeaconScan.cs b/ObservatoryFramework/Files/Journal/Exploration/NavBeaconScan.cs index 299368c..2d1ca74 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/NavBeaconScan.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/NavBeaconScan.cs @@ -1,8 +1,17 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when scanned a populated system's navigation beacon. + /// public class NavBeaconScan : JournalBase { + /// + /// Number of bodies in system. + /// public int NumBodies { get; init; } + /// + /// Unique ID of system. + /// public ulong SystemAddress { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/SAAScanComplete.cs b/ObservatoryFramework/Files/Journal/Exploration/SAAScanComplete.cs index 2c3cb5a..7fa4c81 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/SAAScanComplete.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/SAAScanComplete.cs @@ -2,20 +2,38 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when a body surface scan is completed. + /// public class SAAScanComplete : JournalBase { + /// + /// Unique ID of current system. + /// public ulong SystemAddress { get; init; } + /// + /// Name of the scanned body. + /// public string BodyName { get; init; } + /// + /// ID of the scanned body within the system. + /// public int BodyID { get; init; } /// - /// 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. /// public ImmutableList Discoverers { get; init; } /// - /// 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. /// public ImmutableList Mappers { get; init; } + /// + /// Number of probes fired to complete the surface scan. + /// public int ProbesUsed { get; init; } + /// + /// Maximum number of probes which can be used to get efficiency bonus. + /// public int EfficiencyTarget { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/SAASignalsFound.cs b/ObservatoryFramework/Files/Journal/Exploration/SAASignalsFound.cs index 25b35ca..93b91b8 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/SAASignalsFound.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/SAASignalsFound.cs @@ -3,11 +3,26 @@ using System.Collections.Immutable; namespace Observatory.Framework.Files.Journal { + /// + /// Event written when the surface scan finds signals on the body. + /// public class SAASignalsFound : JournalBase { + /// + /// Unique ID of current system. + /// public ulong SystemAddress { get; init; } + /// + /// Name of the scanned body. + /// public string BodyName { get; init; } + /// + /// ID of the body within the system. + /// public int BodyID { get; init; } + /// + /// List of signals found. + /// public ImmutableList Signals { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/Screenshot.cs b/ObservatoryFramework/Files/Journal/Exploration/Screenshot.cs index 487063a..ad325e4 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/Screenshot.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/Screenshot.cs @@ -1,15 +1,46 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when the player takes a screenshot. + /// public class Screenshot : JournalBase { + /// + /// Filename of the screenshot taken in the form of "\\ED Pictures\\filename" + /// "\\ED Pictures\\" corresponds to "%userprofile%\Pictures\Frontier Developments\Elite Dangerous\" + /// public string Filename { get; init; } + /// + /// Pixel width of the saved image. + /// public int Width { get; init; } + /// + /// Pixel height of the saved image. + /// public int Height { get; init; } + /// + /// System name of the current system. + /// public string System { get; init; } + /// + /// Body name of the current location. + /// public string Body { get; init; } + /// + /// Current latitude if applicable. + /// public float Latitude { get; init; } + /// + /// Current longitude if applicable. + /// public float Longitude { get; init; } + /// + /// Current altitude if applicable. + /// public float Altitude { get; init; } + /// + /// Current heading if applicable. + /// public int Heading { get; init; } } } diff --git a/ObservatoryFramework/Files/Journal/Exploration/SellExplorationData.cs b/ObservatoryFramework/Files/Journal/Exploration/SellExplorationData.cs index 3ab331c..a4a291c 100644 --- a/ObservatoryFramework/Files/Journal/Exploration/SellExplorationData.cs +++ b/ObservatoryFramework/Files/Journal/Exploration/SellExplorationData.cs @@ -2,12 +2,30 @@ namespace Observatory.Framework.Files.Journal { + /// + /// Event generated when selling exploration data. Historically also written for multi-selling, but used only for single system sales in current live game client. + /// public class SellExplorationData : JournalBase { + /// + /// List of systems for which data was sold. + /// public ImmutableList Systems { get; init; } + /// + /// List of first discovered bodies. + /// public ImmutableList Discovered { get; init; } + /// + /// Base value of sold data. + /// public long BaseValue { get; init; } + /// + /// Extra amount from bonuses. + /// public long Bonus { get; init; } + /// + /// Total amount made from selling data. + /// public long TotalEarnings { get; init; } } } diff --git a/ObservatoryFramework/ObservatoryFramework.xml b/ObservatoryFramework/ObservatoryFramework.xml index bc034f2..5dc7740 100644 --- a/ObservatoryFramework/ObservatoryFramework.xml +++ b/ObservatoryFramework/ObservatoryFramework.xml @@ -284,14 +284,419 @@ List of all data currently stored by the player. + + + Journal event generated when buying system data from the galaxy map while docked. + + + + + Name of the system for which data was purchased. + + + + + Amount paid for the data. + + + + + Event generated when an item in the codex is scanned. + + + + + Unique ID of the entry. + + + + + Name of the item scanned. + + + + + Localised name of the item scanned. + + + + + Codex sub category of the item scanned. + + + + + Localised sub category name of the item scanned. + + + + + Codex category of the item scanned. + + + + + Localised category name of the item scanned. + + + + + Codex region the scan occured in. + + + + + Localised name of the region. + + + + + Name of the system in which the scan occured. + + + + + Unique ID of the system in which the scan occured. + + + + + Name of the nearest surface signal. + + + + + Localised name of hte nearest surface signal. + + + + + Indicator that this codex entry hasn't been previously scanned by the CMDR. + + + + + Indicator that htis codex entry has a trait not previously seen by the CMDR. + + + + + List of trais of the scanned item. + + + + + Value of the codex entry when sold to Universal Cartographics. + + + + + Surface latitude where the scan occured. + + + + + Surface longitude where the scan occured. + + + + + Body ID of the system body where the scan occured. + + + + + Event generated when using the discovery scanner (honk) to initially scan system. No longer used in live game client, will be found only in historical data. + + + + + Unique ID of system. + + + + + Number of bodies in system. + + + + + Event generated when all bodies within a system have been scanned. + + + + + Name of the system. + + + + + Unique ID of the system. + + + + + Count of all scanned bodies in system. + + + + + Event generated when the full spectrum scanner finds surface signals on a body. + + + + + Event generated when using the discovery scanner (honk) to initially scan system. + + + + + Name of the current system. + + + + + Unique ID of the current system. + + + + + Percentage of current system already scanned. + + + + + Number of scannable bodies in system. + + + + + Number of scannable non-body locations in system. + + + + + Event generated when a signal source is identified or scanned. + + + + + Name of the signal type. + + + + + Localised name of the signal type. + + + + + Faction state or circumstance that caused this signal to appear. + + + + + Localised description of spawning state. + + + + + Faction name which is associated with this signal. + + + + + Localised name of the associated faction. + + + + + Time until the signal despawns, in seconds. + + + + + Unique ID of current system. + + + + + Numeric representation of the signal threat level. + + + + + Type of signal. + + + + + Localised name of signal type. + + + + + Indicator if the signal is a station which can be docked with. + + + + + Event generated when a material resource is collected. + + + + + Category to which the material belongs. + + + + + Name of the material. + + + + + Localised name of the material. + + + + + Count of the material. + + + + + Event generated when discarding held material resources. + + + + + Event generated the first time a CMDR finds a particular material resource. + + + + + Category of the material. + + + + + Name of the material. + + + + + Localised name of the material. + + + + + Count of the number of discovered items in that category by the CMDR. + + + + + Event generated when discovery data for multiple systems are sold at once. + + + + + List of all sold first discoveries. + + + + + Base value of total sold data. + + + + + Bonus value added to base amount. + + + + + Total amount earned by CMDR for data sale. + + + + + Event generated when scanned a populated system's navigation beacon. + + + + + Number of bodies in system. + + + + + Unique ID of system. + + + + + Event generated when a body surface scan is completed. + + + + + Unique ID of current system. + + + + + Name of the scanned body. + + + + + ID of the scanned body within the system. + + - 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. - 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. + + + + + Number of probes fired to complete the surface scan. + + + + + Maximum number of probes which can be used to get efficiency bonus. + + + + + Event written when the surface scan finds signals on the body. + + + + + Unique ID of current system. + + + + + Name of the scanned body. + + + + + ID of the body within the system. + + + + + List of signals found. @@ -514,6 +919,87 @@ Mean anomaly in degrees. + + + Event generated when the player takes a screenshot. + + + + + Filename of the screenshot taken in the form of "\\ED Pictures\\filename" + "\\ED Pictures\\" corresponds to "%userprofile%\Pictures\Frontier Developments\Elite Dangerous\" + + + + + Pixel width of the saved image. + + + + + Pixel height of the saved image. + + + + + System name of the current system. + + + + + Body name of the current location. + + + + + Current latitude if applicable. + + + + + Current longitude if applicable. + + + + + Current altitude if applicable. + + + + + Current heading if applicable. + + + + + Event generated when selling exploration data. Historically also written for multi-selling, but used only for single system sales in current live game client. + + + + + List of systems for which data was sold. + + + + + List of first discovered bodies. + + + + + Base value of sold data. + + + + + Extra amount from bonuses. + + + + + Total amount made from selling data. + + Elite Dangerous cargo.json file. Describes the current cargo carried above the player's ship.