Clean up store system (#28463)

Content.Shared/Store/Components/StoreComponent.cs

@@ -0,0 +1,122 @@
+using Content.Shared.FixedPoint;
+using Robust.Shared.Audio;
+using Robust.Shared.GameStates;
+using Robust.Shared.Prototypes;
+using Robust.Shared.Serialization.TypeSerializers.Implementations.Custom.Prototype;
+
+namespace Content.Shared.Store.Components;
+
+/// <summary>
+/// This component manages a store which players can use to purchase different listings
+/// through the ui. The currency, listings, and categories are defined in yaml.
+/// </summary>
+[RegisterComponent, NetworkedComponent]
+public sealed partial class StoreComponent : Component
+{
+    [DataField]
+    public LocId Name = "store-ui-default-title";
+
+    /// <summary>
+    /// All the listing categories that are available on this store.
+    /// The available listings are partially based on the categories.
+    /// </summary>
+    [DataField]
+    public HashSet<ProtoId<StoreCategoryPrototype>> Categories = new();
+
+    /// <summary>
+    /// The total amount of currency that can be used in the store.
+    /// The string represents the ID of te currency prototype, where the
+    /// float is that amount.
+    /// </summary>
+    [DataField]
+    public Dictionary<ProtoId<CurrencyPrototype>, FixedPoint2> Balance = new();
+
+    /// <summary>
+    /// The list of currencies that can be inserted into this store.
+    /// </summary>
+    [DataField]
+    public HashSet<ProtoId<CurrencyPrototype>> CurrencyWhitelist = new();
+
+    /// <summary>
+    /// The person who "owns" the store/account. Used if you want the listings to be fixed
+    /// regardless of who activated it. I.E. role specific items for uplinks.
+    /// </summary>
+    [ViewVariables(VVAccess.ReadWrite)]
+    public EntityUid? AccountOwner = null;
+
+    /// <summary>
+    /// All listings, including those that aren't available to the buyer
+    /// </summary>
+    [DataField]
+    public HashSet<ListingData> Listings = new();
+
+    /// <summary>
+    /// All available listings from the last time that it was checked.
+    /// </summary>
+    [ViewVariables]
+    public HashSet<ListingData> LastAvailableListings = new();
+
+    /// <summary>
+    ///     All current entities bought from this shop. Useful for keeping track of refunds and upgrades.
+    /// </summary>
+    [ViewVariables, DataField]
+    public List<EntityUid> BoughtEntities = new();
+
+    /// <summary>
+    ///     The total balance spent in this store. Used for refunds.
+    /// </summary>
+    [ViewVariables, DataField]
+    public Dictionary<ProtoId<CurrencyPrototype>, FixedPoint2> BalanceSpent = new();
+
+    /// <summary>
+    ///     Controls if the store allows refunds
+    /// </summary>
+    [ViewVariables, DataField]
+    public bool RefundAllowed;
+
+    /// <summary>
+    ///     Checks if store can be opened by the account owner only.
+    ///     Not meant to be used with uplinks.
+    /// </summary>
+    [ViewVariables(VVAccess.ReadWrite), DataField]
+    public bool OwnerOnly;
+
+    /// <summary>
+    ///     The map the store was originally from, used to block refunds if the map is changed
+    /// </summary>
+    [DataField]
+    public EntityUid? StartingMap;
+
+    #region audio
+    /// <summary>
+    /// The sound played to the buyer when a purchase is succesfully made.
+    /// </summary>
+    [DataField]
+    public SoundSpecifier BuySuccessSound = new SoundPathSpecifier("/Audio/Effects/kaching.ogg");
+    #endregion
+}
+
+/// <summary>
+/// Event that is broadcast when a store is added to an entity
+/// </summary>
+[ByRefEvent]
+public readonly record struct StoreAddedEvent;
+/// <summary>
+/// Event that is broadcast when a store is removed from an entity
+/// </summary>
+[ByRefEvent]
+public readonly record struct StoreRemovedEvent;
+
+/// <summary>
+///     Broadcast when an Entity with the <see cref="StoreRefundComponent"/> is deleted
+/// </summary>
+[ByRefEvent]
+public readonly struct RefundEntityDeletedEvent
+{
+    public EntityUid Uid { get; }
+
+    public RefundEntityDeletedEvent(EntityUid uid)
+    {
+        Uid = uid;
+    }
+}