Merge pull request #1333 from honeyed-lemons/mail-dv

Mail (Delta-V Port)

Content.Client/_DV/CartridgeLoader/Cartridges/MailMetricUi.cs

@@ -0,0 +1,29 @@
+using Content.Client.UserInterface.Fragments;
+using Content.Shared._DV.CartridgeLoader.Cartridges;
+using Content.Shared.CartridgeLoader.Cartridges;
+using Robust.Client.UserInterface;
+
+namespace Content.Client._DV.CartridgeLoader.Cartridges;
+
+public sealed partial class MailMetricUi : UIFragment
+{
+    private MailMetricUiFragment? _fragment;
+
+    public override Control GetUIFragmentRoot()
+    {
+        return _fragment!;
+    }
+
+    public override void Setup(BoundUserInterface userInterface, EntityUid? fragmentOwner)
+    {
+        _fragment = new MailMetricUiFragment();
+    }
+
+    public override void UpdateState(BoundUserInterfaceState state)
+    {
+        if (state is MailMetricUiState cast)
+        {
+            _fragment?.UpdateState(cast);
+        }
+    }
+}

Content.Client/_DV/CartridgeLoader/Cartridges/MailMetricUiFragment.xaml

@@ -0,0 +1,182 @@
+<cartridges:MailMetricUiFragment
+    xmlns:cartridges="clr-namespace:Content.Client._DV.CartridgeLoader.Cartridges"
+    xmlns:controls="clr-namespace:Content.Client.UserInterface.Controls"
+    xmlns="https://spacestation14.io"
+    Margin="5"
+    VerticalExpand="True"
+    Orientation="Vertical">
+    <PanelContainer StyleClasses="BackgroundDark"></PanelContainer>
+    <controls:StripeBack Name="MailMetricHeaderContainer">
+        <PanelContainer>
+            <Label Name="MailMetricHeader"
+                Align="Center"
+                Text="{Loc 'mail-metrics-header'}" />
+        </PanelContainer>
+    </controls:StripeBack>
+    <BoxContainer
+        Orientation="Vertical"
+        HorizontalExpand="True"
+        Margin="20 0">
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="TitleEmpty1"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True" />
+            <Label Name="MailCountLabel"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                ClipText="True"
+                StyleClasses="monospace"
+                Align="Center"
+                Text="{Loc 'mail-metrics-count-header'}" />
+            <Label Name="SpesosLabel"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                ClipText="True"
+                Align="Center"
+                StyleClasses="monospace"
+                Text="{Loc 'mail-metrics-money-header'}" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="OpenedLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-opened'}" />
+            <Label Name="OpenedMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+            <Label Name="OpenedMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="ExpiredLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-expired'}" />
+            <Label Name="ExpiredMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+            <Label Name="ExpiredMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="TamperedLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-tampered'}" />
+            <Label Name="TamperedMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+            <Label Name="TamperedMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="DamagedLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-damaged'}" />
+            <Label Name="DamagedMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+            <Label Name="DamagedMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                StyleClasses="monospace"
+                Align="Right"
+                ClipText="True" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="UnopenedLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-unopened'}" />
+            <Label Name="UnopenedMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                StyleClasses="monospace"
+                Align="Right"
+                ClipText="True" />
+            <Label Name="UnopenedMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="TotalMailLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-total'}" />
+            <Label Name="TotalMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+            <Label Name="TotalMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+        </BoxContainer>
+    </BoxContainer>
+    <BoxContainer
+        Orientation="Vertical"
+        HorizontalExpand="True"
+        Margin="10">
+        <Label
+            Name="SuccessRateCounts"
+            Align="Center"
+            StyleClasses="LabelBig" />
+        <Label
+            Name="SuccessRatePercent"
+            Align="Center"
+            StyleClasses="LabelBig" />
+    </BoxContainer>
+</cartridges:MailMetricUiFragment>

Content.Client/_DV/CartridgeLoader/Cartridges/MailMetricUiFragment.xaml.cs

@@ -0,0 +1,105 @@
+using Content.Shared._DV.CartridgeLoader.Cartridges;
+using Content.Shared.CartridgeLoader.Cartridges;
+using Robust.Client.AutoGenerated;
+using Robust.Client.UserInterface.Controls;
+using Robust.Client.UserInterface.XAML;
+
+namespace Content.Client._DV.CartridgeLoader.Cartridges;
+
+[GenerateTypedNameReferences]
+public sealed partial class MailMetricUiFragment : BoxContainer
+{
+
+    private OpenedMailPercentGrade? _successGrade;
+
+    public MailMetricUiFragment()
+    {
+        RobustXamlLoader.Load(this);
+
+        // This my way of adding multiple classes to a XAML control.
+        // Haha Batman I'm going to blow up Gotham City
+        OpenedMailCount.StyleClasses.Add("Good");
+        OpenedMailSpesos.StyleClasses.Add("Good");
+        TamperedMailCount.StyleClasses.Add("Danger");
+        TamperedMailSpesos.StyleClasses.Add("Danger");
+        ExpiredMailCount.StyleClasses.Add("Danger");
+        ExpiredMailSpesos.StyleClasses.Add("Danger");
+        DamagedMailCount.StyleClasses.Add("Danger");
+        DamagedMailSpesos.StyleClasses.Add("Danger");
+        UnopenedMailCount.StyleClasses.Add("Caution");
+    }
+
+    public void UpdateState(MailMetricUiState state)
+    {
+        UpdateTextLabels(state);
+        UpdateSuccessGrade(state);
+    }
+
+    public void UpdateTextLabels(MailMetricUiState state)
+    {
+        var stats = state.Metrics;
+
+        OpenedMailCount.Text = stats.OpenedCount.ToString();
+        OpenedMailSpesos.Text = stats.Earnings.ToString();
+        TamperedMailCount.Text = stats.TamperedCount.ToString();
+        TamperedMailSpesos.Text = stats.TamperedLosses.ToString();
+        ExpiredMailCount.Text = stats.ExpiredCount.ToString();
+        ExpiredMailSpesos.Text = stats.ExpiredLosses.ToString();
+        DamagedMailCount.Text = stats.DamagedCount.ToString();
+        DamagedMailSpesos.Text = stats.DamagedLosses.ToString();
+        UnopenedMailCount.Text = state.UnopenedMailCount.ToString();
+        TotalMailCount.Text = state.TotalMail.ToString();
+        TotalMailSpesos.Text = stats.TotalIncome.ToString();
+        SuccessRateCounts.Text = Loc.GetString("mail-metrics-progress",
+            ("opened", stats.OpenedCount),
+            ("total", state.TotalMail));
+        SuccessRatePercent.Text = Loc.GetString("mail-metrics-progress-percent",
+            ("successRate", state.SuccessRate));
+    }
+
+    public void UpdateSuccessGrade(MailMetricUiState state)
+    {
+        var previousGrade = _successGrade;
+        _successGrade = GetSuccessRateGrade(state.SuccessRate);
+
+        // No need to update if they're the same
+        if (previousGrade == _successGrade)
+            return;
+
+        var previousGradeClass = GetClassForGrade(previousGrade);
+        if (previousGradeClass != string.Empty)
+        {
+            SuccessRatePercent.StyleClasses.Remove(previousGradeClass);
+        }
+
+        SuccessRatePercent.StyleClasses.Add(GetClassForGrade(_successGrade));
+    }
+
+    private static OpenedMailPercentGrade GetSuccessRateGrade(double successRate)
+    {
+        return successRate switch
+        {
+            > 75 => OpenedMailPercentGrade.Good,
+            > 50 => OpenedMailPercentGrade.Average,
+            _ => OpenedMailPercentGrade.Bad,
+        };
+    }
+
+    private static string GetClassForGrade(OpenedMailPercentGrade? grade)
+    {
+        return grade switch
+        {
+            OpenedMailPercentGrade.Good => "Good",
+            OpenedMailPercentGrade.Average => "Caution",
+            OpenedMailPercentGrade.Bad => "Danger",
+            _ => string.Empty,
+        };
+    }
+}
+
+public enum OpenedMailPercentGrade : byte
+{
+    Good,
+    Average,
+    Bad
+}

Content.Client/_DV/Mail/MailVisuals.cs

@@ -0,0 +1,60 @@
+using Content.Shared._DV.Mail;
+using Content.Shared.StatusIcon;
+using Robust.Client.GameObjects;
+using Robust.Shared.Prototypes;
+
+namespace Content.Client._DV.Mail;
+
+/// <summary>
+///     Display a cool stamp on the parcel based on the job of the recipient.
+/// </summary>
+/// <remarks>
+///     GenericVisualizer is not powerful enough to handle setting a string on
+///     visual data then directly relaying that string to a layer's state.
+///     I.e. there is nothing like a regex capture group for visual data.
+///     Hence why this system exists.
+///     To do this with GenericVisualizer would require a separate condition
+///     for every job value, which would be extra mess to maintain.
+///     It would look something like this, multipled a couple dozen times.
+///     enum.MailVisuals.JobIcon:
+///     enum.MailVisualLayers.JobStamp:
+///     StationEngineer:
+///     state: StationEngineer
+///     SecurityOfficer:
+///     state: SecurityOfficer
+/// </remarks>
+public sealed class MailJobVisualizerSystem : VisualizerSystem<MailComponent>
+{
+    [Dependency] private readonly IPrototypeManager _proto = default!;
+    [Dependency] private readonly SharedAppearanceSystem _appearance = default!;
+    [Dependency] private readonly SpriteSystem _sprite = default!;
+
+    protected override void OnAppearanceChange(EntityUid uid, MailComponent component, ref AppearanceChangeEvent args)
+    {
+        if (args.Sprite == null)
+            return;
+
+        _appearance.TryGetData(uid, MailVisuals.JobIcon, out string job, args.Component);
+
+        if (string.IsNullOrEmpty(job))
+            job = "JobIconUnknown";
+
+        if (!_proto.TryIndex<JobIconPrototype>(job, out var icon))
+        {
+            args.Sprite.LayerSetTexture(MailVisualLayers.JobStamp, _sprite.Frame0(_proto.Index("JobIconUnknown")));
+            return;
+        }
+
+        args.Sprite.LayerSetTexture(MailVisualLayers.JobStamp, _sprite.Frame0(icon.Icon));
+    }
+}
+
+public enum MailVisualLayers : byte
+{
+    Icon,
+    Lock,
+    FragileStamp,
+    JobStamp,
+    PriorityTape,
+    Breakage
+}

Content.Server/_DV/Cargo/Components/StationLogisticStatsDatabaseComponent.cs

@@ -0,0 +1,14 @@
+using Content.Shared._DV.CartridgeLoader.Cartridges;
+using Content.Shared.Cargo;
+
+namespace Content.Server._DV.Cargo.Components;
+
+/// <summary>
+/// Added to the abstract representation of a station to track stats related to mail delivery and income
+/// </summary>
+[RegisterComponent, Access(typeof(SharedCargoSystem))]
+public sealed partial class StationLogisticStatsComponent : Component
+{
+    [DataField]
+    public MailStats Metrics;
+}