Den Original™ Player Requirements System

Content.Client/IoC/ClientContentIoC.cs

@@ -28,6 +28,8 @@
 using Content.Shared.IoC;
 using Content.Shared.Players.PlayTimeTracking;
 using Content.Shared.Players.RateLimiting;
+using Content.Shared._DEN.Requirements.Managers;
+using Content.Client._DEN.Requirements.Managers;
 
 namespace Content.Client.IoC
 {
@@ -66,6 +68,7 @@ public static void Register(IDependencyCollection collection)
             collection.Register<ClientsidePlaytimeTrackingManager>();
             collection.Register<ClientFeedbackManager>();
             collection.Register<ISharedFeedbackManager, ClientFeedbackManager>();
+            collection.Register<IPlayerRequirementManager, PlayerRequirementManager>(); // DEN
         }
     }
 }

Content.Client/Players/PlayTimeTracking/JobRequirementsManager.cs

@@ -1,4 +1,5 @@
 using System.Diagnostics.CodeAnalysis;
+using Content.Shared._DEN.Requirements.Managers;
 using Content.Shared.CCVar;
 using Content.Shared.Players;
 using Content.Shared.Players.JobWhitelist;
@@ -15,14 +16,15 @@
 
 namespace Content.Client.Players.PlayTimeTracking;
 
-public sealed class JobRequirementsManager : ISharedPlaytimeManager
+public sealed partial class JobRequirementsManager : ISharedPlaytimeManager // DEN: Make partial
 {
     [Dependency] private readonly IBaseClient _client = default!;
     [Dependency] private readonly IClientNetManager _net = default!;
     [Dependency] private readonly IConfigurationManager _cfg = default!;
     [Dependency] private readonly IEntityManager _entManager = default!;
     [Dependency] private readonly IPlayerManager _playerManager = default!;
     [Dependency] private readonly IPrototypeManager _prototypes = default!;
+    [Dependency] private readonly IPlayerRequirementManager _requirements = default!; // DEN
 
     private readonly Dictionary<string, TimeSpan> _roles = new();
     private readonly List<ProtoId<JobPrototype>> _jobBans = new();
@@ -148,10 +150,21 @@ public bool IsAllowed(
             return false;
 
         // Check other role requirements
+        // TODO DEN: This is deprecated
         var reqs = _entManager.System<SharedRoleSystem>().GetRoleRequirements(job);
         if (!CheckRoleRequirements(reqs, profile, out reason))
             return false;
 
+        // Begin DEN: Use player requirements
+        var roleSystem = _entManager.System<SharedRoleSystem>();
+        var requirements = roleSystem.GetRolePlayerRequirements(job);
+        if (requirements != null && !PassesRequirements(profile, requirements, out var context))
+        {
+            reason = SharedPlayerRequirementManager.GetCombinedReason(requirements, context);
+            return false;
+        }
+        // End DEN
+
         return true;
     }
 
@@ -175,14 +188,26 @@ public bool IsAllowed(
             return false;
 
         // Check other role requirements
+        // TODO DEN: This is deprecated
         var reqs = _entManager.System<SharedRoleSystem>().GetRoleRequirements(antag);
         if (!CheckRoleRequirements(reqs, profile, out reason))
             return false;
 
+        // Begin DEN: Use player requirements
+        var roleSystem = _entManager.System<SharedRoleSystem>();
+        var requirements = roleSystem.GetRolePlayerRequirements(antag);
+        if (requirements != null && !PassesRequirements(profile, requirements, out var context))
+        {
+            reason = SharedPlayerRequirementManager.GetCombinedReason(requirements, context);
+            return false;
+        }
+        // End DEN
+
         return true;
     }
 
     // This must be private so code paths can't accidentally skip requirement overrides. Call this through IsAllowed()
+    [Obsolete("Use SharedPlayerRequirementManager.CheckRequirements() instead")] // DEN
     private bool CheckRoleRequirements(HashSet<JobRequirement>? requirements, HumanoidCharacterProfile? profile, [NotNullWhen(false)] out FormattedMessage? reason)
     {
         reason = null;

Content.Client/_DEN/Lobby/UI/Traits/EntityTraitSelector.xaml.cs

@@ -1,14 +1,23 @@
+using System.Text;
+using Content.Shared._DEN.Requirements.Managers;
 using Content.Shared._DEN.Traits.Prototypes;
 using Robust.Client.AutoGenerated;
+using Robust.Client.Player;
+using Robust.Client.UserInterface;
 using Robust.Client.UserInterface.Controls;
+using Robust.Client.UserInterface.CustomControls;
 using Robust.Client.UserInterface.XAML;
 using Robust.Shared.Prototypes;
+using Robust.Shared.Utility;
 
 namespace Content.Client._DEN.Lobby.UI.Traits;
 
 [GenerateTypedNameReferences]
 public sealed partial class EntityTraitSelector : BoxContainer
 {
+    [Dependency] private readonly IPlayerManager _player = default!;
+    [Dependency] private readonly IPlayerRequirementManager _requirements = default!;
+
     public event Action<bool>? PreferenceChanged;
 
     public int Cost { private set; get; } = 0;
@@ -19,19 +28,23 @@ public bool Preference
     }
 
     public ProtoId<EntityTraitPrototype>? PrototypeId { private set; get; } = null;
+    private EntityTraitPrototype? _trait = null;
 
     public EntityTraitSelector(EntityTraitPrototype trait)
     {
         RobustXamlLoader.Load(this);
+        IoCManager.InjectDependencies(this);
 
         SetTrait(trait);
         SelectorCheckbox.OnToggled += args => { PreferenceChanged?.Invoke(args.Pressed); };
+        SelectorCheckbox.TooltipSupplier = SupplyTooltip;
     }
 
     private void SetTrait(EntityTraitPrototype trait)
     {
         Cost = trait.Cost;
         PrototypeId = trait.ID;
+        _trait = trait;
 
         var text = "";
 
@@ -40,9 +53,88 @@ private void SetTrait(EntityTraitPrototype trait)
 
         text += Loc.GetString(trait.Name);
         SelectorCheckbox.Text = text;
+        UpdateVisibility(trait);
+    }
+
+    /// <summary>
+    ///     Retrieve this session's context.
+    /// </summary>
+    /// <returns>The local player's session context.</returns>
+    private PlayerRequirementContext GetContext()
+    {
+        var session = _player.LocalSession;
+        if (session == null)
+            return new();
+
+        var context = _requirements.GetPlayerContext(session);
+        return context;
+    }
+
+    /// <summary>
+    ///     Toggles the visibility of this selector, depending on the requirements of a given trait.
+    /// </summary>
+    /// <param name="trait">The trait to check the requirements of.</param>
+    private void UpdateVisibility(EntityTraitPrototype trait)
+    {
+        var context = GetContext();
+        Visible = !SharedPlayerRequirementManager.ShouldHide(context, trait.Requirements);
+    }
+
+    /// <summary>
+    ///     Provide a tooltip to this control if it has a valid trait set.
+    ///     This includes the trait's description and its requirement text.
+    /// </summary>
+    /// <returns>A tooltip with the trait's description, if this control has a trait.</returns>
+    private Tooltip? SupplyTooltip(Control sender)
+    {
+        if (_trait is null)
+            return null;
 
+        var context = _trait.Requirements.Count > 0
+            ? GetContext()
+            : null;
+
+        var tooltipString = ConstructTooltipDescription(_trait, context);
+        if (tooltipString.Length == 0)
+            return null;
+
+        var tooltip = new Tooltip();
+        if (FormattedMessage.TryFromMarkup(tooltipString, out var msg))
+            tooltip.SetMessage(msg);
+
+        return tooltip;
+    }
+
+    /// <summary>
+    ///     Construct a full tooltip description for a given trait.
+    /// </summary>
+    /// <param name="trait">The trait to construct a description out of.</param>
+    /// <returns>The tooltip text associated with this trait.</returns>
+    private static string ConstructTooltipDescription(EntityTraitPrototype trait,
+        PlayerRequirementContext? context = null)
+    {
+        var tooltipBuilder = new StringBuilder();
+
+        // Add description
         if (trait.Description is not null)
-            SelectorCheckbox.ToolTip = Loc.GetString(trait.Description.Value);
+            tooltipBuilder.AppendLine(Loc.GetString(trait.Description.Value));
+
+        // Add requirement reason texts
+        if (trait.Requirements.Count > 0)
+        {
+            tooltipBuilder.AppendLine(); // Empty line
+            foreach (var requirement in trait.Requirements)
+            {
+                var reason = requirement.GetReason(context);
+                if (reason is null)
+                    continue;
+
+                tooltipBuilder.AppendLine(reason);
+            }
+        }
+
+        var tooltipString = tooltipBuilder.ToString().Trim();
+        return tooltipString;
     }
 
     public void SetInvalid(bool invalid)

Content.Client/_DEN/Lobby/UI/Traits/TraitCategoryBox.xaml.cs

@@ -46,8 +46,7 @@ public void SetTraits(List<EntityTraitPrototype> traits)
 
         foreach (var trait in traits)
         {
-            if (!trait.Selectable || trait.AllowedSpecies is not null
-                    && (_profile?.Species is null || !trait.AllowedSpecies.Contains(_profile.Species)))
+            if (!trait.Selectable)
                 continue;
 
             var selector = new EntityTraitSelector(trait);

Content.Client/_DEN/Players/PlayTimeTracking/JobRequirementManager.cs

@@ -0,0 +1,32 @@
+using Content.Shared._DEN.Requirements.Managers;
+using Content.Shared._DEN.Requirements.PlayerRequirements;
+using Content.Shared.Preferences;
+using Content.Shared.Roles;
+
+namespace Content.Client.Players.PlayTimeTracking;
+
+public sealed partial class JobRequirementsManager
+{
+    /// <summary>
+    ///     Check if we pass a given list of requirements.
+    ///     A profile may be optionally supplied to replace the one in the context.
+    /// </summary>
+    /// <param name="profile">A profile associated with the character we're loading in.</param>
+    /// <param name="requirements">The requirements to check.</param>
+    /// <param name="The context we generated to check requirements.</param>
+    /// <returns>Whether we pass the requirements given.</returns>
+    private bool PassesRequirements(HumanoidCharacterProfile? profile,
+        List<IPlayerRequirement> requirements,
+        out PlayerRequirementContext context)
+    {
+        var session = _playerManager.LocalSession;
+        context = session != null
+            ? _requirements.GetPlayerContext(session)
+            : new();
+
+        if (profile != null)
+            context.Profile = profile;
+
+        return SharedPlayerRequirementManager.CheckRequirements(context, requirements);
+    }
+}

Content.Client/_DEN/Requirements/Managers/PlayerRequirementManager.cs

@@ -0,0 +1,31 @@
+using Content.Client.Lobby;
+using Content.Shared._DEN.Requirements.Managers;
+using Content.Shared.Players.PlayTimeTracking;
+using Robust.Client.Player;
+using Robust.Shared.Player;
+
+namespace Content.Client._DEN.Requirements.Managers;
+
+/// <inheritdoc />
+public sealed partial class PlayerRequirementManager : SharedPlayerRequirementManager
+{
+    [Dependency] private readonly IPlayerManager _player = default!;
+    [Dependency] private readonly IClientPreferencesManager _preferences = default!;
+    [Dependency] private readonly ISharedPlaytimeManager _playtimeManager = default!;
+
+    /// <inheritdoc />
+    public override PlayerRequirementContext GetPlayerContext(ICommonSession session)
+    {
+        if (_player.LocalSession != session)
+            return new();
+
+        var playtimes = _playtimeManager.GetPlayTimes(session);
+        var profile = _preferences.Preferences?.SelectedCharacter;
+
+        return new()
+        {
+            Playtimes = playtimes,
+            Profile = profile,
+        };
+    }
+}

Content.Server/IoC/ServerContentIoC.cs

@@ -1,3 +1,4 @@
+using Content.Server._DEN.Requirements.Managers;
 using Content.Server.Administration;
 using Content.Server.Administration.Logs;
 using Content.Server.Administration.Managers;
@@ -24,6 +25,7 @@
 using Content.Server.ServerUpdates;
 using Content.Server.Voting.Managers;
 using Content.Server.Worldgen.Tools;
+using Content.Shared._DEN.Requirements.Managers;
 using Content.Shared.Administration.Logs;
 using Content.Shared.Administration.Managers;
 using Content.Shared.Chat;
@@ -84,5 +86,6 @@ public static void Register(IDependencyCollection deps)
         deps.Register<DiscordChatLink>();
         deps.Register<ServerFeedbackManager>();
         deps.Register<ISharedFeedbackManager, ServerFeedbackManager>();
+        deps.Register<IPlayerRequirementManager, PlayerRequirementManager>(); // DEN
     }
 }