Action Upgrade System (#22277)

* Adds uses before delay so actions can be used multiple times before cooldown * adds methods to get remaining charges, to set uses before delay, and to set use delay * adds method to change action name * moves set usedelay * action upgrade ECS * adds method to reset remaining uses * adds upgrade events * refactors action upgrade event and adds logic to parse it * fix serialization issue * adds level up draft method * adds action commands and a command to upgrade an action * more warning lines to help * Gets action to upgrade properly * Removes unneeded fields from the action upgrade component and now properly raises the level of the new action * Cleans up dead code and comments * Fixes punctuation in actions-commands and adds a TryUpgradeAction method. * removes TODO comment * robust fix * removes RT * readds RT * update RT to 190 * removes change name method * removes remaining uses & related fields and adds that functionality to charges * Adds Charges to action tooltips that require it
2023-12-15 04:41:44 -05:00
parent 39cda517a5
commit 2d692f47da
14 changed files with 438 additions and 5 deletions
--- a/Content.Shared/Actions/ActionUpgradeSystem.cs
+++ b/Content.Shared/Actions/ActionUpgradeSystem.cs
@@ -0,0 +1,149 @@
+using System.Diagnostics.CodeAnalysis;
+using System.Linq;
+using Content.Shared.Actions.Events;
+using Robust.Shared.Prototypes;
+using Robust.Shared.Utility;
+
+namespace Content.Shared.Actions;
+
+public sealed class ActionUpgradeSystem : EntitySystem
+{
+    [Dependency] private readonly SharedActionsSystem _actions = default!;
+    [Dependency] private readonly ActionContainerSystem _actionContainer = default!;
+    [Dependency] private readonly EntityManager _entityManager = default!;
+
+    public override void Initialize()
+    {
+        base.Initialize();
+
+        SubscribeLocalEvent<ActionUpgradeComponent, ActionUpgradeEvent>(OnActionUpgradeEvent);
+    }
+
+    private void OnActionUpgradeEvent(EntityUid uid, ActionUpgradeComponent component, ActionUpgradeEvent args)
+    {
+        if (!CanLevelUp(args.NewLevel, component.EffectedLevels, out var newActionProto)
+            || !_actions.TryGetActionData(uid, out var actionComp))
+            return;
+
+        var originalContainer = actionComp.Container;
+        var originalAttachedEntity = actionComp.AttachedEntity;
+
+        _actionContainer.RemoveAction(uid, actionComp);
+
+        EntityUid? upgradedActionId = null;
+        if (originalContainer != null
+            && TryComp<ActionsContainerComponent>(originalContainer.Value, out var actionContainerComp))
+        {
+            upgradedActionId = _actionContainer.AddAction(originalContainer.Value, newActionProto, actionContainerComp);
+
+            if (originalAttachedEntity != null)
+                _actions.GrantContainedActions(originalAttachedEntity.Value, originalContainer.Value);
+            else
+                _actions.GrantContainedActions(originalContainer.Value, originalContainer.Value);
+        }
+        else if (originalAttachedEntity != null)
+        {
+            upgradedActionId = _actionContainer.AddAction(originalAttachedEntity.Value, newActionProto);
+        }
+
+        if (!TryComp<ActionUpgradeComponent>(upgradedActionId, out var upgradeComp))
+            return;
+
+        upgradeComp.Level = args.NewLevel;
+
+        // TODO: Preserve ordering of actions
+
+        _entityManager.DeleteEntity(uid);
+    }
+
+    public bool TryUpgradeAction(EntityUid? actionId, ActionUpgradeComponent? actionUpgradeComponent = null, int newLevel = 0)
+    {
+        if (!TryGetActionUpgrade(actionId, out var actionUpgradeComp))
+            return false;
+
+        actionUpgradeComponent ??= actionUpgradeComp;
+        DebugTools.AssertNotNull(actionUpgradeComponent);
+        DebugTools.AssertNotNull(actionId);
+
+        if (newLevel < 1)
+            newLevel = actionUpgradeComponent.Level + 1;
+
+        if (!CanLevelUp(newLevel, actionUpgradeComponent.EffectedLevels, out _))
+            return false;
+
+        UpgradeAction(actionId, actionUpgradeComp);
+        return true;
+    }
+
+    // TODO: Add checks for branching upgrades
+    private bool CanLevelUp(
+        int newLevel,
+        Dictionary<int, EntProtoId> levelDict,
+        [NotNullWhen(true)]out EntProtoId? newLevelProto)
+    {
+        newLevelProto = null;
+
+        if (levelDict.Count < 1)
+            return false;
+
+        var canLevel = false;
+        var finalLevel = levelDict.Keys.ToList()[levelDict.Keys.Count - 1];
+
+        foreach (var (level, proto) in levelDict)
+        {
+            if (newLevel != level || newLevel > finalLevel)
+                continue;
+
+            canLevel = true;
+            newLevelProto = proto;
+            DebugTools.AssertNotNull(newLevelProto);
+            break;
+        }
+
+        return canLevel;
+    }
+
+    /// <summary>
+    ///     Raises a level by one
+    /// </summary>
+    public void UpgradeAction(EntityUid? actionId, ActionUpgradeComponent? actionUpgradeComponent = null, int newLevel = 0)
+    {
+        if (!TryGetActionUpgrade(actionId, out var actionUpgradeComp))
+            return;
+
+        actionUpgradeComponent ??= actionUpgradeComp;
+        DebugTools.AssertNotNull(actionUpgradeComponent);
+        DebugTools.AssertNotNull(actionId);
+
+        if (newLevel < 1)
+            newLevel = actionUpgradeComponent.Level + 1;
+
+        RaiseActionUpgradeEvent(newLevel, actionId.Value);
+    }
+
+    private void RaiseActionUpgradeEvent(int level, EntityUid actionId)
+    {
+        var ev = new ActionUpgradeEvent(level, actionId);
+        RaiseLocalEvent(actionId, ev);
+    }
+
+    public bool TryGetActionUpgrade(
+        [NotNullWhen(true)] EntityUid? uid,
+        [NotNullWhen(true)] out ActionUpgradeComponent? result,
+        bool logError = true)
+    {
+        result = null;
+        if (!Exists(uid))
+            return false;
+
+        if (!TryComp<ActionUpgradeComponent>(uid, out var actionUpgradeComponent))
+        {
+            Log.Error($"Failed to get action upgrade from action entity: {ToPrettyString(uid.Value)}");
+            return false;
+        }
+
+        result = actionUpgradeComponent;
+        DebugTools.AssertOwner(uid, result);
+        return true;
+    }
+}