public interface FreightSystemInterface { /// <summary> /// List of all items that the interface has available to provide to the freight system /// </summary> List<FreightListing> FreightOfferings { get; } /// <summary> /// List of all items that the interface wants delivered to it by the freight system /// </summary> List<FreightListing> FreightRequests { get; } /// <summary> /// List of the interface's current inventory available for transit /// Must exist on either FreightOfferings or FreightRequests list to be tallied /// </summary> List<FreightListing> FreightInventory { get; } /// <summary> /// Checked each tick by the connected freight station. If true the station will query /// the master freight registry for the freight data associated with the stations network. /// This request is costly, avoid making frequent requests! The registry fully updates /// every 3 seconds so requests more frequent than this are unnecessary. Cache locally! /// </summary> bool FreightDataRequest { get; } /// <summary> /// Queried freight network data is passed to the interface here /// </summary> /// <param name="data">Current freight status for the connected station's network.</param> void FreightNetworkData(List<FreightData> data); /// <summary> /// The freight system calls this when it has an item to offer to the interface /// </summary> /// <param name="item">The item being offered to the interface</param> /// <returns>True if the item is accepted</returns> bool ReceiveFreight(ItemBase item); /// <summary> /// The freight system calls this when requesting an item from the interface /// </summary> /// <param name="item">The item the freight system wants the interface to provide</param> /// <returns>True if the interface successfully provides the item</returns> bool ProvideFreight(ItemBase item); } /// <summary> /// Class representing a freight item and offered/requested quantity /// </summary> public class FreightListing { public ItemBase Item { get; } public int Quantity { get; set; } public FreightListing(ItemBase item, int quantity) { Item = item; Quantity = quantity; } //Some operator and comparison overrides to make them directly comparable to ItemBase } /// <summary> /// Class containing basic freight system status information /// </summary> public class FreightData { /// <summary> /// The Freight Item traded on the network /// </summary> public ItemBase FreightItem { get; } /// <summary> /// Total quantity of this freight item among all mass storage with networked stations /// Hoppers do not contribute to network inventory. /// </summary> public int Inventory { get; } /// <summary> /// The sum of all demand across the network for this item /// </summary> public int Deficit { get; } /// <summary> /// The sum of all excess offered available for delivery to requesting stations /// </summary> public int Surplus { get; } /// <summary> /// Current stock of this item in transit in the freight system /// </summary> public int Stock { get; } public FreightData(ItemBase item, int inv, int def, int sur, int stock) { FreightItem = item; Inventory = inv; Deficit = def; Surplus = sur; Stock = stock; } }