mirror of
				https://github.com/9ParsonsB/Pulsar.git
				synced 2025-10-30 22:24:58 -04:00 
			
		
		
		
	More xml docs.
This commit is contained in:
		| @@ -3,11 +3,26 @@ using System.Collections.Immutable; | |||||||
|  |  | ||||||
| namespace Observatory.Framework.Files.Journal | namespace Observatory.Framework.Files.Journal | ||||||
| { | { | ||||||
|  |     /// <summary> | ||||||
|  |     /// Elite Dangerous backpack.json file. Describes all the items currently carried by the player. | ||||||
|  |     /// </summary> | ||||||
|     public class BackpackFile : JournalBase |     public class BackpackFile : JournalBase | ||||||
|     { |     { | ||||||
|  |         /// <summary> | ||||||
|  |         /// List of all items carried. | ||||||
|  |         /// </summary> | ||||||
|         public ImmutableList<BackpackItem> Items { get; init; } |         public ImmutableList<BackpackItem> Items { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// List of all components carried. | ||||||
|  |         /// </summary> | ||||||
|         public ImmutableList<BackpackItem> Components { get; init; } |         public ImmutableList<BackpackItem> Components { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// List of player consumable items carried. | ||||||
|  |         /// </summary> | ||||||
|         public ImmutableList<BackpackItem> Consumables { get; init; } |         public ImmutableList<BackpackItem> Consumables { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// List of all data currently stored by the player. | ||||||
|  |         /// </summary> | ||||||
|         public ImmutableList<BackpackItem> Data { get; init; } |         public ImmutableList<BackpackItem> Data { get; init; } | ||||||
|     } |     } | ||||||
| } | } | ||||||
|   | |||||||
| @@ -3,10 +3,22 @@ using System.Collections.Immutable; | |||||||
|  |  | ||||||
| namespace Observatory.Framework.Files | namespace Observatory.Framework.Files | ||||||
| { | { | ||||||
|  |     /// <summary> | ||||||
|  |     /// Elite Dangerous cargo.json file. Describes the current cargo carried above the player's ship. | ||||||
|  |     /// </summary> | ||||||
|     public class CargoFile : Journal.JournalBase |     public class CargoFile : Journal.JournalBase | ||||||
|     { |     { | ||||||
|  |         /// <summary> | ||||||
|  |         /// Type of vehicle currently being reported. "Ship" or "SRV". | ||||||
|  |         /// </summary> | ||||||
|         public string Vessel { get; init; } |         public string Vessel { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// Number of different types of cargo carried(?) | ||||||
|  |         /// </summary> | ||||||
|         public int Count { get; init; } |         public int Count { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// List of full cargo details. | ||||||
|  |         /// </summary> | ||||||
|         public ImmutableList<CargoType> Inventory { get; init; } |         public ImmutableList<CargoType> Inventory { get; init; } | ||||||
|     } |     } | ||||||
| } | } | ||||||
|   | |||||||
| @@ -3,12 +3,30 @@ using System.Collections.Immutable; | |||||||
|  |  | ||||||
| namespace Observatory.Framework.Files | namespace Observatory.Framework.Files | ||||||
| { | { | ||||||
|  |     /// <summary> | ||||||
|  |     /// Elite Dangerous market.json file. Contains details about all available commodities available at the current station. | ||||||
|  |     /// </summary> | ||||||
|     public class MarketFile : Journal.JournalBase |     public class MarketFile : Journal.JournalBase | ||||||
|     { |     { | ||||||
|  |         /// <summary> | ||||||
|  |         /// Unique ID of current market. | ||||||
|  |         /// </summary> | ||||||
|         public long MarketID { get; init; } |         public long MarketID { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// Name of the station where the market is located. | ||||||
|  |         /// </summary> | ||||||
|         public string StationName { get; init; } |         public string StationName { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// Type of station where the market is located. | ||||||
|  |         /// </summary> | ||||||
|         public string StationType { get; init; } |         public string StationType { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// Name of star system where the market is located. | ||||||
|  |         /// </summary> | ||||||
|         public string StarSystem { get; init; } |         public string StarSystem { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// List of all commodities available in the market. | ||||||
|  |         /// </summary> | ||||||
|         public ImmutableList<MarketItem> Items { get; init; } |         public ImmutableList<MarketItem> Items { get; init; } | ||||||
|     } |     } | ||||||
| } | } | ||||||
|   | |||||||
| @@ -3,8 +3,14 @@ using System.Collections.Immutable; | |||||||
|  |  | ||||||
| namespace Observatory.Framework.Files | namespace Observatory.Framework.Files | ||||||
| { | { | ||||||
|  |     /// <summary> | ||||||
|  |     /// Information about current player ship equipped modules. | ||||||
|  |     /// </summary> | ||||||
|     public class ModulesInfo : Journal.JournalBase |     public class ModulesInfo : Journal.JournalBase | ||||||
|     { |     { | ||||||
|  |         /// <summary> | ||||||
|  |         /// List of all equipped modules. | ||||||
|  |         /// </summary> | ||||||
|         public ImmutableList<Module> Modules { get; init; } |         public ImmutableList<Module> Modules { get; init; } | ||||||
|     } |     } | ||||||
| } | } | ||||||
|   | |||||||
| @@ -3,8 +3,14 @@ using System.Collections.Immutable; | |||||||
|  |  | ||||||
| namespace Observatory.Framework.Files | namespace Observatory.Framework.Files | ||||||
| { | { | ||||||
|  |     /// <summary> | ||||||
|  |     /// Elite Dangerous navroute.json file. Contains data about currently plotted FSD jump route. | ||||||
|  |     /// </summary> | ||||||
|     public class NavRouteFile : Journal.JournalBase |     public class NavRouteFile : Journal.JournalBase | ||||||
|     { |     { | ||||||
|  |         /// <summary> | ||||||
|  |         /// List of star systems and their locations in the current route. | ||||||
|  |         /// </summary> | ||||||
|         public ImmutableList<Route> Route { get; init; } |         public ImmutableList<Route> Route { get; init; } | ||||||
|     } |     } | ||||||
| } | } | ||||||
|   | |||||||
| @@ -3,12 +3,30 @@ using System.Collections.Immutable; | |||||||
|  |  | ||||||
| namespace Observatory.Framework.Files | namespace Observatory.Framework.Files | ||||||
| { | { | ||||||
|  |     /// <summary> | ||||||
|  |     /// Elite Dangerous outfitting.json file. Contains data about ship modules available for purchase at the current station. | ||||||
|  |     /// </summary> | ||||||
|     public class OutfittingFile : Journal.JournalBase |     public class OutfittingFile : Journal.JournalBase | ||||||
|     { |     { | ||||||
|  |         /// <summary> | ||||||
|  |         /// Unique ID of current market. | ||||||
|  |         /// </summary> | ||||||
|         public long MarketID { get; init; } |         public long MarketID { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// Name of the station where the market is located. | ||||||
|  |         /// </summary> | ||||||
|         public string StationName { get; init; } |         public string StationName { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// Name of the star system where the market is located. | ||||||
|  |         /// </summary> | ||||||
|         public string StarSystem { get; init; } |         public string StarSystem { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// Indicator if the player has access to Horizons content. | ||||||
|  |         /// </summary> | ||||||
|         public bool Horizons { get; init; } |         public bool Horizons { get; init; } | ||||||
|  |         /// <summary> | ||||||
|  |         /// List of all available parts in shipyard. | ||||||
|  |         /// </summary> | ||||||
|         public ImmutableList<OutfittingModule> Items { get; init; } |         public ImmutableList<OutfittingModule> Items { get; init; } | ||||||
|     } |     } | ||||||
| } | } | ||||||
|   | |||||||
| @@ -4,12 +4,12 @@ using System.Collections.Immutable; | |||||||
| namespace Observatory.Framework.Files | namespace Observatory.Framework.Files | ||||||
| { | { | ||||||
|     /// <summary> |     /// <summary> | ||||||
|     /// Elite Dangerous shipyard.json file. |     /// Elite Dangerous shipyard.json file. Contains data about ships available for purchase at the current station. | ||||||
|     /// </summary> |     /// </summary> | ||||||
|     public class ShipyardFile : Journal.JournalBase |     public class ShipyardFile : Journal.JournalBase | ||||||
|     { |     { | ||||||
|         /// <summary> |         /// <summary> | ||||||
|         /// Unique ID of market. |         /// Unique ID of current market. | ||||||
|         /// </summary> |         /// </summary> | ||||||
|         public ulong MarketID { get; init; } |         public ulong MarketID { get; init; } | ||||||
|         /// <summary> |         /// <summary> | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user