Wizard Item Recall Spell #34411

ScarKy0 · 2025-01-13T01:18:53Z

About the PR

Title.

Why / Balance

Missing feature for wizard.

Technical details

Added an ItemRecallSystem that handles the Item Recall spell.
Added RaiseOnAction to the BaseActionComponent to allow raising events on the action itself.

Media

2025-01-13.23-50-15.mp4

Requirements

I have read and am following the Pull Request and Changelog Guidelines.
I have added media to this PR or it does not require an ingame showcase.

Breaking changes

Changelog

not player facing (wizard when :( )

SlimmSlamm · 2025-01-13T01:51:56Z

would this work if its in someone elses inventory/locker?

ScarKy0 · 2025-01-13T02:17:13Z

would this work if its in someone elses inventory/locker?

If the item exists, no matter where, it WILL return to you

SlimmSlamm · 2025-01-13T04:59:54Z

would this work if its in someone elses inventory/locker?

If the item exists, no matter where, it WILL return to you

thats awesome. hope to see some interactions with storage implanters or something. that would be hilarious.

Content.Shared/ItemRecall/ItemRecallComponent.cs

0x6273 · 2025-01-13T13:58:02Z

Isn't there a freeze on wizard and new spells?

keronshb · 2025-01-13T14:07:38Z

Isn't there a freeze on wizard and new spells?

This has permission from me.

everydayeldergod · 2025-01-14T12:13:06Z

should it do some damage if it uh... rips a storage implanter out of someone's chest? or is it more of a magical teleport?

slarticodefast

I did not test it in game yet.
Design-wise, did you ask Keron if it should be one or two actions? One for marking, one for recalling. That way you change the mark to another item if you wanted to.

Content.Client/ItemRecall/ItemRecallSystem.cs

Content.Server/ItemRecall/ItemRecallSystem.cs

Content.Shared/Projectiles/SharedProjectileSystem.cs

Content.Shared/Actions/SharedActionsSystem.cs

Content.Shared/ItemRecall/ItemRecallEvents.cs

Content.Shared/ItemRecall/SharedItemRecallSystem.cs

ScarKy0 · 2025-01-14T12:24:13Z

I did not test it in game yet.
Design-wise, did you ask Keron if it should be one or two actions? One for marking, one for recalling. That way you change the mark to another item if you wanted to.

Spoke with Keron, youre not supposed to be able to mark another item(mark is permanent unless item somehow is destroyed) and it should be one action.
Thanks for the review ill address it all later

ScarKy0 · 2025-01-14T12:29:13Z

should it do some damage if it uh... rips a storage implanter out of someone's chest? or is it more of a magical teleport?

As cool as this sounds, magical teleport

Content.Shared/Projectiles/SharedProjectileSystem.cs

Content.Shared/ItemRecall/ItemRecallComponent.cs

Content.Shared/ItemRecall/ItemRecallEvents.cs

Content.Shared/ItemRecall/RecallMarkerComponent.cs

ScarKy0 · 2025-01-15T17:09:30Z

Only thing that doesn't work is the popup when an item is unmarked, but it's something to do with the action system being weird.

github-actions · 2025-01-16T20:47:41Z

RSI Diff Bot; head commit b81ca5d merging into b308589
This PR makes changes to 1 or more RSIs. Here is a summary of all changes:

Resources/Textures/Objects/Magic/magicactions.rsi

State	Old	New	Status
item_recall			Added

Edit: diff updated after b81ca5d

Resources/Locale/en-US/item-recall/item-recall.ftl

metalgearsloth · 2025-01-19T23:25:12Z

Content.Server/ItemRecall/ItemRecallSystem.cs

+/// <summary>
+/// System for handling the ItemRecall ability for wizards.
+/// </summary>
+public sealed partial class ItemRecallSystem : SharedItemRecallSystem
+{
+    [Dependency] private readonly SharedHandsSystem _hands = default!;
+    [Dependency] private readonly SharedProjectileSystem _proj = default!;
+    [Dependency] private readonly SharedPopupSystem _popups = default!;
+
+    public override void Initialize()
+    {
+        base.Initialize();
+
+        SubscribeLocalEvent<RecallMarkerComponent, RecallItemEvent>(OnItemRecall);
+    }
+
+    private void OnItemRecall(Entity<RecallMarkerComponent> ent, ref RecallItemEvent args)
+    {
+        RecallItem(ent);
+    }
+
+    private void RecallItem(Entity<RecallMarkerComponent> ent)
+    {
+        if (!TryComp<InstantActionComponent>(ent.Comp.MarkedByAction, out var instantAction))
+            return;
+
+        var actionOwner = instantAction.AttachedEntity;
+
+        if (actionOwner == null)
+            return;
+
+        if (TryComp<EmbeddableProjectileComponent>(ent, out var projectile))
+            _proj.UnEmbed(ent, projectile, actionOwner.Value);
+
+        _popups.PopupEntity(Loc.GetString("item-recall-item-summon", ("item", ent)), actionOwner.Value, actionOwner.Value);
+
+        _hands.TryForcePickupAnyHand(actionOwner.Value, ent);
+    }
+}


All new code needs prediction please.

If your issue is range use pvs session overrides.

Content.Shared/ItemRecall/ItemRecallComponent.cs

metalgearsloth · 2025-01-19T23:27:35Z

Content.Shared/ItemRecall/RecallMarkerComponent.cs

+
+[RegisterComponent, NetworkedComponent, AutoGenerateComponentState, Access(typeof(SharedItemRecallSystem))]
+public sealed partial class RecallMarkerComponent : Component
+{


Doc comments.

metalgearsloth · 2025-01-19T23:28:36Z

Content.Shared/ItemRecall/SharedItemRecallSystem.cs

+
+    private void TryMarkItem(Entity<ItemRecallComponent> ent, EntityUid item, EntityUid markedBy)
+    {
+        EnsureComp<RecallMarkerComponent>(item, out var marker);
+        ent.Comp.MarkedEntity = item;
+        Dirty(ent);
+


This is already checked for component existence above but if you're doing ensures then you should actually be checking if the item should be dirtied or not as dirtying is expensive and this might be unnecessary.

metalgearsloth · 2025-01-19T23:29:19Z

Content.Shared/ItemRecall/SharedItemRecallSystem.cs

+
+        if (TryComp<ItemRecallComponent>(marker.MarkedByAction, out var action))
+        {
+            // For some reason client thinks the station grid owns the action on client and this doesn't work. It doesn't work in PopupEntity(mispredicts) and PopupPredicted either(doesnt show).
+            // I don't have the heart to move this code to server because of this small thing.
+            // This line will only do something once that is fixed.


This sounds like a pretty bad bug here that should be fixed.

Messing with the action system is not something I am knowledgable enough to do. Especially since I have no idea what causes this.

metalgearsloth · 2025-01-19T23:30:10Z

Content.Shared/ItemRecall/SharedItemRecallSystem.cs

+
+    private void UpdateActionAppearance(Entity<ItemRecallComponent> action)
+    {
+        if (!TryComp<InstantActionComponent>(action, out var instantAction))
+            return;
+
+        var proto = Prototype(action);
+
+        if (proto == null)
+            return;
+
+        if (action.Comp.MarkedEntity == null)
+        {
+            _metaData.SetEntityName(action, proto.Name);
+            _metaData.SetEntityDescription(action, proto.Description);
+            _actions.SetEntityIcon(action, null, instantAction);
+        }
+        else
+        {
+            if (action.Comp.WhileMarkedName != null)
+                _metaData.SetEntityName(action, Loc.GetString(action.Comp.WhileMarkedName,
+                    ("item", action.Comp.MarkedEntity.Value)));
+
+            if (action.Comp.WhileMarkedDescription != null)
+                _metaData.SetEntityDescription(action, Loc.GetString(action.Comp.WhileMarkedDescription,
+                    ("item", action.Comp.MarkedEntity.Value)));
+
+            _actions.SetEntityIcon(action, action.Comp.MarkedEntity, instantAction);
+        }


You should be getting the entity's actual data not prototype data, this can vary significantly as prototypes are only for initialisation values.

I do mean to get the initial state of the action here though. Since if the item for recall is destroyed the initial sprite should be restored.

Content.Shared/Actions/BaseActionComponent.cs

metalgearsloth · 2025-01-19T23:32:48Z

Content.Shared/ItemRecall/SharedItemRecallSystem.cs

+
+    private void TryUnmarkItem(EntityUid item)
+    {
+        if (!TryComp<RecallMarkerComponent>(item, out var marker))
+            return;
+
+        if (!TryComp<InstantActionComponent>(item, out var instantAction))
+            return;
+
+        var actionOwner = instantAction.AttachedEntity;
+
+        if (actionOwner == null)
+            return;
+


If the item is being recalled the attached entity can be completely different? Not sure why the action is even being checked here.

If you use mind swap and then recall an item you would recall it to your old body. This is supposed to recall it to whoever currently holds the action.

metalgearsloth · 2025-01-19T23:33:26Z

Content.Shared/Projectiles/SharedProjectileSystem.cs

+        // Reset whether the projectile has damaged anything if it successfully was removed
+        if (TryComp<ProjectileComponent>(uid, out var projectile))
+        {
+            projectile.Shooter = null;
+            projectile.Weapon = null;
+            projectile.DamagedEntity = false;
+        }
+


This should be getting dirtied, looks like bug in original code.

Init

4cff026

github-actions bot added S: Untriaged Status: Indicates an item has not been triaged and doesn't have appropriate labels. size/M Denotes a PR that changes 100-999 lines. labels Jan 13, 2025

metalgearsloth reviewed Jan 13, 2025

View reviewed changes

Content.Shared/ItemRecall/ItemRecallComponent.cs Outdated Show resolved Hide resolved

ScarKy0 added 2 commits January 13, 2025 11:41

embeddable proj fix

ce089fb

Unbind on break

d83c940

ScarKy0 and others added 3 commits January 13, 2025 19:14

Merge branch 'space-wizards:master' into item-recall-ability

c105732

Cooldown fix

1ba3134

a lot of stuff

6e6e040

ScarKy0 marked this pull request as ready for review January 13, 2025 23:09

ScarKy0 changed the title ~~[Draft] Wizard Item Recall Spell~~ Wizard Item Recall Spell Jan 13, 2025

ScarKy0 requested a review from metalgearsloth January 13, 2025 23:30

github-actions bot added the S: Needs Review Status: Requires additional reviews before being fully accepted label Jan 13, 2025

slarticodefast requested changes Jan 14, 2025

View reviewed changes

slarticodefast added S: Awaiting Changes Status: Changes are required before another review can happen and removed S: Needs Review Status: Requires additional reviews before being fully accepted labels Jan 14, 2025

Requested Changes part 1

be5d4d5

metalgearsloth reviewed Jan 14, 2025

View reviewed changes

Content.Shared/Projectiles/SharedProjectileSystem.cs Outdated Show resolved Hide resolved

metalgearsloth reviewed Jan 14, 2025

View reviewed changes

Content.Shared/ItemRecall/ItemRecallComponent.cs Outdated Show resolved Hide resolved

metalgearsloth reviewed Jan 14, 2025

View reviewed changes

Content.Shared/ItemRecall/ItemRecallEvents.cs Outdated Show resolved Hide resolved

metalgearsloth reviewed Jan 14, 2025

View reviewed changes

Content.Shared/ItemRecall/RecallMarkerComponent.cs Outdated Show resolved Hide resolved

Requested Changes part 2

008ea64

ScarKy0 added 5 commits January 15, 2025 15:37

Requested Changes part 3

0828c0f

Requested Changes part 4

4d685ae

Requested Changes part 5

eadd12a

Requested Changes part 6

8515fac

something something fixes

8eaf4db

ScarKy0 requested review from slarticodefast and metalgearsloth January 15, 2025 17:08

github-actions bot added S: Needs Review Status: Requires additional reviews before being fully accepted and removed S: Awaiting Changes Status: Changes are required before another review can happen labels Jan 15, 2025

sprite + sound changes

a8f6c51

github-actions bot added the Changes: Sprites Changes: Might require knowledge of spriting or visual design. label Jan 16, 2025

keronshb requested changes Jan 19, 2025

View reviewed changes

Resources/Locale/en-US/item-recall/item-recall.ftl Outdated Show resolved Hide resolved

requested changes

b81ca5d

ScarKy0 requested a review from keronshb January 19, 2025 21:13

keronshb approved these changes Jan 19, 2025

View reviewed changes

metalgearsloth requested changes Jan 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wizard Item Recall Spell #34411

Wizard Item Recall Spell #34411

ScarKy0 commented Jan 13, 2025 •

edited

Loading

SlimmSlamm commented Jan 13, 2025

ScarKy0 commented Jan 13, 2025

SlimmSlamm commented Jan 13, 2025

0x6273 commented Jan 13, 2025

keronshb commented Jan 13, 2025

everydayeldergod commented Jan 14, 2025

slarticodefast left a comment

ScarKy0 commented Jan 14, 2025

ScarKy0 commented Jan 14, 2025

ScarKy0 commented Jan 15, 2025

github-actions bot commented Jan 16, 2025 •

edited

Loading

metalgearsloth Jan 19, 2025 •

edited

Loading

metalgearsloth Jan 19, 2025

metalgearsloth Jan 19, 2025

metalgearsloth Jan 19, 2025

ScarKy0 Jan 19, 2025

metalgearsloth Jan 19, 2025

ScarKy0 Jan 19, 2025

metalgearsloth Jan 19, 2025

ScarKy0 Jan 19, 2025

metalgearsloth Jan 19, 2025

Wizard Item Recall Spell #34411

Are you sure you want to change the base?

Wizard Item Recall Spell #34411

Conversation

ScarKy0 commented Jan 13, 2025 • edited Loading

About the PR

Why / Balance

Technical details

Media

Requirements

Breaking changes

SlimmSlamm commented Jan 13, 2025

ScarKy0 commented Jan 13, 2025

SlimmSlamm commented Jan 13, 2025

0x6273 commented Jan 13, 2025

keronshb commented Jan 13, 2025

everydayeldergod commented Jan 14, 2025

slarticodefast left a comment

Choose a reason for hiding this comment

ScarKy0 commented Jan 14, 2025

ScarKy0 commented Jan 14, 2025

ScarKy0 commented Jan 15, 2025

github-actions bot commented Jan 16, 2025 • edited Loading

metalgearsloth Jan 19, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ScarKy0 commented Jan 13, 2025 •

edited

Loading

github-actions bot commented Jan 16, 2025 •

edited

Loading

metalgearsloth Jan 19, 2025 •

edited

Loading