From 89a6bb3ab5897da04c0526c32ff408b90bfc70fc Mon Sep 17 00:00:00 2001
From: SimpleStation14 <130339894+SimpleStation14@users.noreply.github.com>
Date: Mon, 1 Jul 2024 11:37:45 -0700
Subject: [PATCH] Mirror: StrippableSystem doafter overhaul (#205)
## Mirror of PR #25994: [StrippableSystem doafter
overhaul](https://github.com/space-wizards/space-station-14/pull/25994)
from
[space-wizards](https://github.com/space-wizards)/[space-station-14](https://github.com/space-wizards/space-station-14)
###### `41ca8f3dfcb986432e1e509247bf239cac137836`
PR opened by Krunklehorn at
2024-03-11 12:36:28 UTC
---
PR changed 7 files with 465 additions and 305 deletions.
The PR had the following labels:
- Status: Needs Review
---
Original Body
> ## About the PR
>
> Refactors Strippable DoAfter events to make them synchronous and
organized.
>
>
> ## Technical details
>
> ### Strippable System & Component
> - Synchronous DoAfters
> - Made use of `TimeSpan`, `GetStripTimeModifiers()` and `ByRefEvent`
> - Reorganized checks, removed some redundant ones
> - Resolve pattern where useful
> - Added more asserts
> - Lots of cleanup
>
> The DoAfters were grouped under one event to avoid copy-pasting eight
separate cancel checks, asserts and function signatures.
>
> Let me know if this is bad for performance and I'll roll them out
instead.
>
>
> ## Media
>
> - [x] I have added screenshots/videos to this PR showcasing its
changes ingame, **or** this PR does not require an ingame showcase
>
>
> ## Breaking changes
>
> ### TimeSpans
> `ThievingComponent`, `InventoryTemplatePrototype` and
`ToggleableClothingSystem` use `TimeSpan` in places where they intersect
with `StrippableComponent`.
>
>
> **Changelog**
>
> N/A
>
Signed-off-by: VMSolidus
Co-authored-by: SimpleStation14
Co-authored-by: VMSolidus
---
Content.Server/Strip/StrippableSystem.cs | 676 +++++++++++-------
.../EntitySystems/ToggleableClothingSystem.cs | 2 +-
.../Inventory/InventoryTemplatePrototype.cs | 2 +-
.../Strip/Components/StrippableComponent.cs | 81 +--
.../Strip/Components/ThievingComponent.cs | 2 +-
.../Strip/SharedStrippableSystem.cs | 6 +-
Content.Shared/Strip/ThievingSystem.cs | 1 +
7 files changed, 465 insertions(+), 305 deletions(-)
diff --git a/Content.Server/Strip/StrippableSystem.cs b/Content.Server/Strip/StrippableSystem.cs
index 96b2ecc00c6..950411a8e2c 100644
--- a/Content.Server/Strip/StrippableSystem.cs
+++ b/Content.Server/Strip/StrippableSystem.cs
@@ -1,4 +1,3 @@
-using System.Linq;
using Content.Server.Administration.Logs;
using Content.Server.Ensnaring;
using Content.Shared.CombatMode;
@@ -21,18 +20,21 @@
using Robust.Server.GameObjects;
using Robust.Shared.Player;
using Robust.Shared.Utility;
+using System.Linq;
namespace Content.Server.Strip
{
public sealed class StrippableSystem : SharedStrippableSystem
{
- [Dependency] private readonly SharedCuffableSystem _cuffable = default!;
- [Dependency] private readonly SharedHandsSystem _handsSystem = default!;
[Dependency] private readonly InventorySystem _inventorySystem = default!;
- [Dependency] private readonly SharedDoAfterSystem _doAfter = default!;
- [Dependency] private readonly SharedPopupSystem _popup = default!;
- [Dependency] private readonly EnsnareableSystem _ensnaring = default!;
+ [Dependency] private readonly EnsnareableSystem _ensnaringSystem = default!;
[Dependency] private readonly UserInterfaceSystem _userInterfaceSystem = default!;
+
+ [Dependency] private readonly SharedCuffableSystem _cuffableSystem = default!;
+ [Dependency] private readonly SharedDoAfterSystem _doAfterSystem = default!;
+ [Dependency] private readonly SharedHandsSystem _handsSystem = default!;
+ [Dependency] private readonly SharedPopupSystem _popupSystem = default!;
+
[Dependency] private readonly IAdminLogManager _adminLogger = default!;
// TODO: ECS popups. Not all of these have ECS equivalents yet.
@@ -48,64 +50,58 @@ public override void Initialize()
// BUI
SubscribeLocalEvent(OnStripButtonPressed);
SubscribeLocalEvent(OnStripEnsnareMessage);
+
+ // DoAfters
+ SubscribeLocalEvent>(OnStrippableDoAfterRunning);
+ SubscribeLocalEvent(OnStrippableDoAfterFinished);
}
- private void OnStripEnsnareMessage(EntityUid uid, EnsnareableComponent component, StrippingEnsnareButtonPressed args)
+ private void AddStripVerb(EntityUid uid, StrippableComponent component, GetVerbsEvent args)
{
- if (args.Session.AttachedEntity is not {Valid: true} user)
+ if (args.Hands == null || !args.CanAccess || !args.CanInteract || args.Target == args.User)
return;
- foreach (var entity in component.Container.ContainedEntities)
+ if (!HasComp(args.User))
+ return;
+
+ Verb verb = new()
{
- if (!TryComp(entity, out var ensnaring))
- continue;
+ Text = Loc.GetString("strip-verb-get-data-text"),
+ Icon = new SpriteSpecifier.Texture(new("/Textures/Interface/VerbIcons/outfit.svg.192dpi.png")),
+ Act = () => StartOpeningStripper(args.User, (uid, component), true),
+ };
- _ensnaring.TryFree(uid, user, entity, ensnaring);
- return;
- }
+ args.Verbs.Add(verb);
}
- private void OnStripButtonPressed(Entity strippable, ref StrippingSlotButtonPressed args)
+ private void AddStripExamineVerb(EntityUid uid, StrippableComponent component, GetVerbsEvent args)
{
- if (args.Session.AttachedEntity is not {Valid: true} user ||
- !TryComp(user, out var userHands))
- return;
-
- if (args.IsHand)
- {
- StripHand(user, args.Slot, strippable, userHands);
+ if (args.Hands == null || !args.CanAccess || !args.CanInteract || args.Target == args.User)
return;
- }
- if (!TryComp(strippable, out var inventory))
+ if (!HasComp(args.User))
return;
- var hasEnt = _inventorySystem.TryGetSlotEntity(strippable, args.Slot, out var held, inventory);
+ ExamineVerb verb = new()
+ {
+ Text = Loc.GetString("strip-verb-get-data-text"),
+ Icon = new SpriteSpecifier.Texture(new("/Textures/Interface/VerbIcons/outfit.svg.192dpi.png")),
+ Act = () => StartOpeningStripper(args.User, (uid, component), true),
+ Category = VerbCategory.Examine,
+ };
- if (userHands.ActiveHandEntity != null && !hasEnt)
- PlaceActiveHandItemInInventory(user, strippable, userHands.ActiveHandEntity.Value, args.Slot, strippable);
- else if (userHands.ActiveHandEntity == null && hasEnt)
- TakeItemFromInventory(user, strippable, held!.Value, args.Slot, strippable);
+ args.Verbs.Add(verb);
}
- private void StripHand(EntityUid user, string handId, Entity target, HandsComponent userHands)
+ private void OnActivateInWorld(EntityUid uid, StrippableComponent component, ActivateInWorldEvent args)
{
- if (!_handsSystem.TryGetHand(target, handId, out var hand))
+ if (args.Target == args.User)
return;
- // is the target a handcuff?
- if (TryComp(hand.HeldEntity, out VirtualItemComponent? virt)
- && TryComp(target, out CuffableComponent? cuff)
- && _cuffable.GetAllCuffs(cuff).Contains(virt.BlockingEntity))
- {
- _cuffable.TryUncuff(target, user, virt.BlockingEntity, cuffable: cuff);
+ if (!HasComp(args.User))
return;
- }
- if (userHands.ActiveHandEntity != null && hand.HeldEntity == null)
- PlaceActiveHandItemInHands(user, target, userHands.ActiveHandEntity.Value, handId, target);
- else if (userHands.ActiveHandEntity == null && hand.HeldEntity != null)
- TakeItemFromHands(user, target, hand.HeldEntity.Value, handId, target);
+ StartOpeningStripper(args.User, (uid, component));
}
public override void StartOpeningStripper(EntityUid user, Entity strippable, bool openInCombat = false)
@@ -123,352 +119,514 @@ public override void StartOpeningStripper(EntityUid user, Entity args)
+ private void OnStripButtonPressed(Entity strippable, ref StrippingSlotButtonPressed args)
{
- if (args.Hands == null || !args.CanAccess || !args.CanInteract || args.Target == args.User)
+ if (args.Session.AttachedEntity is not { Valid: true } user ||
+ !TryComp(user, out var userHands) ||
+ !TryComp(strippable.Owner, out var targetHands))
return;
- if (!HasComp(args.User))
+ if (args.IsHand)
+ {
+ StripHand((user, userHands), (strippable.Owner, targetHands), args.Slot, strippable);
return;
+ }
- Verb verb = new()
- {
- Text = Loc.GetString("strip-verb-get-data-text"),
- Icon = new SpriteSpecifier.Texture(new ("/Textures/Interface/VerbIcons/outfit.svg.192dpi.png")),
- Act = () => StartOpeningStripper(args.User, (uid, component), true),
- };
- args.Verbs.Add(verb);
+ if (!TryComp(strippable, out var inventory))
+ return;
+
+ var hasEnt = _inventorySystem.TryGetSlotEntity(strippable, args.Slot, out var held, inventory);
+
+ if (userHands.ActiveHandEntity != null && !hasEnt)
+ StartStripInsertInventory((user, userHands), strippable.Owner, userHands.ActiveHandEntity.Value, args.Slot);
+ else if (userHands.ActiveHandEntity == null && hasEnt)
+ StartStripRemoveInventory(user, strippable.Owner, held!.Value, args.Slot);
}
- private void AddStripExamineVerb(EntityUid uid, StrippableComponent component, GetVerbsEvent args)
+ private void StripHand(
+ Entity user,
+ Entity target,
+ string handId,
+ StrippableComponent? targetStrippable)
{
- if (args.Hands == null || !args.CanAccess || !args.CanInteract || args.Target == args.User)
+ if (!Resolve(user, ref user.Comp) ||
+ !Resolve(target, ref target.Comp) ||
+ !Resolve(target, ref targetStrippable))
return;
- if (!HasComp(args.User))
+ if (!_handsSystem.TryGetHand(target.Owner, handId, out var handSlot))
return;
- ExamineVerb verb = new()
+ // Is the target a handcuff?
+ if (TryComp(handSlot.HeldEntity, out var virtualItem) &&
+ TryComp(target.Owner, out var cuffable) &&
+ _cuffableSystem.GetAllCuffs(cuffable).Contains(virtualItem.BlockingEntity))
{
- Text = Loc.GetString("strip-verb-get-data-text"),
- Icon = new SpriteSpecifier.Texture(new ("/Textures/Interface/VerbIcons/outfit.svg.192dpi.png")),
- Act = () => StartOpeningStripper(args.User, (uid, component), true),
- Category = VerbCategory.Examine,
- };
+ _cuffableSystem.TryUncuff(target.Owner, user, virtualItem.BlockingEntity, cuffable);
+ return;
+ }
- args.Verbs.Add(verb);
+ if (user.Comp.ActiveHandEntity != null && handSlot.HeldEntity == null)
+ StartStripInsertHand(user, target, user.Comp.ActiveHandEntity.Value, handId, targetStrippable);
+ else if (user.Comp.ActiveHandEntity == null && handSlot.HeldEntity != null)
+ StartStripRemoveHand(user, target, handSlot.HeldEntity.Value, handId, targetStrippable);
}
- private void OnActivateInWorld(EntityUid uid, StrippableComponent component, ActivateInWorldEvent args)
+ private void OnStripEnsnareMessage(EntityUid uid, EnsnareableComponent component, StrippingEnsnareButtonPressed args)
{
- if (args.Target == args.User)
+ if (args.Session.AttachedEntity is not { Valid: true } user)
return;
- if (!HasComp(args.User))
- return;
+ foreach (var entity in component.Container.ContainedEntities)
+ {
+ if (!TryComp(entity, out var ensnaring))
+ continue;
- StartOpeningStripper(args.User, (uid, component));
+ _ensnaringSystem.TryFree(uid, user, entity, ensnaring);
+ return;
+ }
}
///
- /// Places item in user's active hand to an inventory slot.
+ /// Checks whether the item is in a user's active hand and whether it can be inserted into the inventory slot.
///
- private async void PlaceActiveHandItemInInventory(
- EntityUid user,
+ private bool CanStripInsertInventory(
+ Entity user,
EntityUid target,
EntityUid held,
- string slot,
- StrippableComponent component)
+ string slot)
{
- var userHands = Comp(user);
+ if (!Resolve(user, ref user.Comp))
+ return false;
+
+ if (user.Comp.ActiveHand == null)
+ return false;
+
+ if (user.Comp.ActiveHandEntity == null)
+ return false;
+
+ if (user.Comp.ActiveHandEntity != held)
+ return false;
+
+ if (!_handsSystem.CanDropHeld(user, user.Comp.ActiveHand))
+ {
+ _popupSystem.PopupCursor(Loc.GetString("strippable-component-cannot-drop"), user);
+ return false;
+ }
+
+ if (_inventorySystem.TryGetSlotEntity(target, slot, out _))
+ {
+ _popupSystem.PopupCursor(Loc.GetString("strippable-component-item-slot-occupied", ("owner", target)), user);
+ return false;
+ }
- bool Check()
+ if (!_inventorySystem.CanEquip(user, target, held, slot, out _))
{
- if (userHands.ActiveHandEntity != held)
- return false;
-
- if (!_handsSystem.CanDropHeld(user, userHands.ActiveHand!))
- {
- _popup.PopupCursor(Loc.GetString("strippable-component-cannot-drop"), user);
- return false;
- }
-
- if (_inventorySystem.TryGetSlotEntity(target, slot, out _))
- {
- _popup.PopupCursor(Loc.GetString("strippable-component-item-slot-occupied",("owner", target)), user);
- return false;
- }
-
- if (!_inventorySystem.CanEquip(user, target, held, slot, out _))
- {
- _popup.PopupCursor(Loc.GetString("strippable-component-cannot-equip-message",("owner", target)), user);
- return false;
- }
-
- return true;
+ _popupSystem.PopupCursor(Loc.GetString("strippable-component-cannot-equip-message", ("owner", target)), user);
+ return false;
}
+ return true;
+ }
+
+ ///
+ /// Begins a DoAfter to insert the item in the user's active hand into the inventory slot.
+ ///
+ private void StartStripInsertInventory(
+ Entity user,
+ EntityUid target,
+ EntityUid held,
+ string slot)
+ {
+ if (!Resolve(user, ref user.Comp))
+ return;
+
+ if (!CanStripInsertInventory(user, target, held, slot))
+ return;
+
if (!_inventorySystem.TryGetSlot(target, slot, out var slotDef))
{
Log.Error($"{ToPrettyString(user)} attempted to place an item in a non-existent inventory slot ({slot}) on {ToPrettyString(target)}");
return;
}
- var userEv = new BeforeStripEvent(slotDef.StripTime);
- RaiseLocalEvent(user, userEv);
- var ev = new BeforeGettingStrippedEvent(userEv.Time, userEv.Stealth);
- RaiseLocalEvent(target, ev);
+ var (time, stealth) = GetStripTimeModifiers(user, target, slotDef.StripTime);
+
+ if (!stealth)
+ _popupSystem.PopupEntity(Loc.GetString("strippable-component-alert-owner-insert", ("user", Identity.Entity(user, EntityManager)), ("item", user.Comp.ActiveHandEntity!.Value)), target, target, PopupType.Large);
+
+ var prefix = stealth ? "stealthily " : "";
+ _adminLogger.Add(LogType.Stripping, LogImpact.Low, $"{ToPrettyString(user):actor} is trying to {prefix}place the item {ToPrettyString(held):item} in {ToPrettyString(target):target}'s {slot} slot");
- var doAfterArgs = new DoAfterArgs(EntityManager, user, ev.Time, new AwaitedDoAfterEvent(), null, target: target, used: held)
+ var doAfterArgs = new DoAfterArgs(EntityManager, user, time, new StrippableDoAfterEvent(true, true, slot), user, target, held)
{
- ExtraCheck = Check,
- Hidden = ev.Stealth,
+ Hidden = stealth,
AttemptFrequency = AttemptFrequency.EveryTick,
BreakOnDamage = true,
BreakOnTargetMove = true,
BreakOnUserMove = true,
NeedHand = true,
- DuplicateCondition = DuplicateConditions.SameTool // Block any other DoAfters featuring this same entity.
+ DuplicateCondition = DuplicateConditions.SameTool
};
- if (!ev.Stealth && Check() && userHands.ActiveHandEntity != null)
- {
- var message = Loc.GetString("strippable-component-alert-owner-insert",
- ("user", Identity.Entity(user, EntityManager)), ("item", userHands.ActiveHandEntity));
- _popup.PopupEntity(message, target, target, PopupType.Large);
- }
+ _doAfterSystem.TryStartDoAfter(doAfterArgs);
+ }
- var prefix = ev.Stealth ? "stealthily " : "";
- _adminLogger.Add(LogType.Stripping, LogImpact.Low, $"{ToPrettyString(user):actor} is trying to {prefix}place the item {ToPrettyString(held):item} in {ToPrettyString(target):target}'s {slot} slot");
+ ///
+ /// Inserts the item in the user's active hand into the inventory slot.
+ ///
+ private void StripInsertInventory(
+ Entity user,
+ EntityUid target,
+ EntityUid held,
+ string slot)
+ {
+ if (!Resolve(user, ref user.Comp))
+ return;
- var result = await _doAfter.WaitDoAfter(doAfterArgs);
- if (result != DoAfterStatus.Finished)
+ if (!CanStripInsertInventory(user, target, held, slot))
return;
- DebugTools.Assert(userHands.ActiveHand?.HeldEntity == held);
+ if (!_handsSystem.TryDrop(user, handsComp: user.Comp))
+ return;
+
+ _inventorySystem.TryEquip(user, target, held, slot);
+ _adminLogger.Add(LogType.Stripping, LogImpact.Medium, $"{ToPrettyString(user):actor} has placed the item {ToPrettyString(held):item} in {ToPrettyString(target):target}'s {slot} slot");
+ }
- if (_handsSystem.TryDrop(user, handsComp: userHands))
+ ///
+ /// Checks whether the item can be removed from the target's inventory.
+ ///
+ private bool CanStripRemoveInventory(
+ EntityUid user,
+ EntityUid target,
+ EntityUid item,
+ string slot)
+ {
+ if (!_inventorySystem.TryGetSlotEntity(target, slot, out var slotItem))
{
- _inventorySystem.TryEquip(user, target, held, slot);
+ _popupSystem.PopupCursor(Loc.GetString("strippable-component-item-slot-free-message", ("owner", target)), user);
+ return false;
+ }
- _adminLogger.Add(LogType.Stripping, LogImpact.Medium, $"{ToPrettyString(user):actor} has placed the item {ToPrettyString(held):item} in {ToPrettyString(target):target}'s {slot} slot");
+ if (slotItem != item)
+ return false;
+
+ if (!_inventorySystem.CanUnequip(user, target, slot, out var reason))
+ {
+ _popupSystem.PopupCursor(Loc.GetString(reason), user);
+ return false;
}
+
+ return true;
}
///
- /// Places item in user's active hand in one of the entity's hands.
+ /// Begins a DoAfter to remove the item from the target's inventory and insert it in the user's active hand.
///
- private async void PlaceActiveHandItemInHands(
+ private void StartStripRemoveInventory(
EntityUid user,
EntityUid target,
- EntityUid held,
- string handName,
- StrippableComponent component)
+ EntityUid item,
+ string slot)
{
- var hands = Comp(target);
- var userHands = Comp(user);
+ if (!CanStripRemoveInventory(user, target, item, slot))
+ return;
- bool Check()
+ if (!_inventorySystem.TryGetSlot(target, slot, out var slotDef))
{
- if (userHands.ActiveHandEntity != held)
- return false;
-
- if (!_handsSystem.CanDropHeld(user, userHands.ActiveHand!))
- {
- _popup.PopupCursor(Loc.GetString("strippable-component-cannot-drop"), user);
- return false;
- }
-
- if (!_handsSystem.TryGetHand(target, handName, out var hand, hands)
- || !_handsSystem.CanPickupToHand(target, userHands.ActiveHandEntity.Value, hand, checkActionBlocker: false, hands))
- {
- _popup.PopupCursor(Loc.GetString("strippable-component-cannot-put-message",("owner", target)), user);
- return false;
- }
-
- return true;
+ Log.Error($"{ToPrettyString(user)} attempted to take an item from a non-existent inventory slot ({slot}) on {ToPrettyString(target)}");
+ return;
}
- var userEv = new BeforeStripEvent(component.HandStripDelay);
- RaiseLocalEvent(user, userEv);
- var ev = new BeforeGettingStrippedEvent(userEv.Time, userEv.Stealth);
- RaiseLocalEvent(target, ev);
+ var (time, stealth) = GetStripTimeModifiers(user, target, slotDef.StripTime);
- var doAfterArgs = new DoAfterArgs(EntityManager, user, ev.Time, new AwaitedDoAfterEvent(), null, target: target, used: held)
+ if (!stealth)
{
- ExtraCheck = Check,
- Hidden = ev.Stealth,
+ if (slotDef.StripHidden)
+ _popupSystem.PopupEntity(Loc.GetString("strippable-component-alert-owner-hidden", ("slot", slot)), target, target, PopupType.Large);
+ else
+ _popupSystem.PopupEntity(Loc.GetString("strippable-component-alert-owner", ("user", Identity.Entity(user, EntityManager)), ("item", item)), target, target, PopupType.Large);
+ }
+
+ var prefix = stealth ? "stealthily " : "";
+ _adminLogger.Add(LogType.Stripping, LogImpact.Low, $"{ToPrettyString(user):actor} is trying to {prefix}strip the item {ToPrettyString(item):item} from {ToPrettyString(target):target}'s {slot} slot");
+
+ var doAfterArgs = new DoAfterArgs(EntityManager, user, time, new StrippableDoAfterEvent(false, true, slot), user, target, item)
+ {
+ Hidden = stealth,
AttemptFrequency = AttemptFrequency.EveryTick,
BreakOnDamage = true,
BreakOnTargetMove = true,
BreakOnUserMove = true,
NeedHand = true,
+ BreakOnHandChange = false, // Allow simultaneously removing multiple items.
DuplicateCondition = DuplicateConditions.SameTool
};
- var prefix = ev.Stealth ? "stealthily " : "";
- _adminLogger.Add(LogType.Stripping, LogImpact.Low, $"{ToPrettyString(user):actor} is trying to {prefix}place the item {ToPrettyString(held):item} in {ToPrettyString(target):target}'s hands");
-
- var result = await _doAfter.WaitDoAfter(doAfterArgs);
- if (result != DoAfterStatus.Finished) return;
-
- _handsSystem.TryDrop(user, checkActionBlocker: false, handsComp: userHands);
- _handsSystem.TryPickup(target, held, handName, checkActionBlocker: false, animateUser: !ev.Stealth, animate: !ev.Stealth, handsComp: hands);
- _adminLogger.Add(LogType.Stripping, LogImpact.Medium, $"{ToPrettyString(user):actor} has placed the item {ToPrettyString(held):item} in {ToPrettyString(target):target}'s hands");
- // hand update will trigger strippable update
+ _doAfterSystem.TryStartDoAfter(doAfterArgs);
}
///
- /// Takes an item from the inventory and places it in the user's active hand.
+ /// Removes the item from the target's inventory and inserts it in the user's active hand.
///
- private async void TakeItemFromInventory(
+ private void StripRemoveInventory(
EntityUid user,
EntityUid target,
EntityUid item,
string slot,
- Entity strippable)
+ bool stealth)
+ {
+ if (!CanStripRemoveInventory(user, target, item, slot))
+ return;
+
+ if (!_inventorySystem.TryUnequip(user, target, slot))
+ return;
+
+ RaiseLocalEvent(item, new DroppedEvent(user), true); // Gas tank internals etc.
+
+ _handsSystem.PickupOrDrop(user, item, animateUser: stealth, animate: stealth);
+ _adminLogger.Add(LogType.Stripping, LogImpact.Medium, $"{ToPrettyString(user):actor} has stripped the item {ToPrettyString(item):item} from {ToPrettyString(target):target}'s {slot} slot");
+ }
+
+ ///
+ /// Checks whether the item in the user's active hand can be inserted into one of the target's hands.
+ ///
+ private bool CanStripInsertHand(
+ Entity user,
+ Entity target,
+ EntityUid held,
+ string handName)
{
- bool Check()
+ if (!Resolve(user, ref user.Comp) ||
+ !Resolve(target, ref target.Comp))
+ return false;
+
+ if (user.Comp.ActiveHand == null)
+ return false;
+
+ if (user.Comp.ActiveHandEntity == null)
+ return false;
+
+ if (user.Comp.ActiveHandEntity != held)
+ return false;
+
+ if (!_handsSystem.CanDropHeld(user, user.Comp.ActiveHand))
{
- if (!_inventorySystem.TryGetSlotEntity(target, slot, out var ent) && ent == item)
- {
- _popup.PopupCursor(Loc.GetString("strippable-component-item-slot-free-message", ("owner", target)), user);
- return false;
- }
-
- if (!_inventorySystem.CanUnequip(user, target, slot, out var reason))
- {
- _popup.PopupCursor(Loc.GetString(reason), user);
- return false;
- }
-
- return true;
+ _popupSystem.PopupCursor(Loc.GetString("strippable-component-cannot-drop"), user);
+ return false;
}
- if (!_inventorySystem.TryGetSlot(target, slot, out var slotDef))
+ if (!_handsSystem.TryGetHand(target, handName, out var handSlot, target.Comp) ||
+ !_handsSystem.CanPickupToHand(target, user.Comp.ActiveHandEntity.Value, handSlot, checkActionBlocker: false, target.Comp))
{
- Log.Error($"{ToPrettyString(user)} attempted to take an item from a non-existent inventory slot ({slot}) on {ToPrettyString(target)}");
- return;
+ _popupSystem.PopupCursor(Loc.GetString("strippable-component-cannot-put-message", ("owner", target)), user);
+ return false;
}
- var userEv = new BeforeStripEvent(slotDef.StripTime);
- RaiseLocalEvent(user, userEv);
- var ev = new BeforeGettingStrippedEvent(userEv.Time, userEv.Stealth);
- RaiseLocalEvent(target, ev);
+ return true;
+ }
+
+ ///
+ /// Begins a DoAfter to insert the item in the user's active hand into one of the target's hands.
+ ///
+ private void StartStripInsertHand(
+ Entity user,
+ Entity target,
+ EntityUid held,
+ string handName,
+ StrippableComponent? targetStrippable = null)
+ {
+ if (!Resolve(user, ref user.Comp) ||
+ !Resolve(target, ref target.Comp) ||
+ !Resolve(target, ref targetStrippable))
+ return;
+
+ if (!CanStripInsertHand(user, target, held, handName))
+ return;
- var doAfterArgs = new DoAfterArgs(EntityManager, user, ev.Time, new AwaitedDoAfterEvent(), null, target: target, used: item)
+ var (time, stealth) = GetStripTimeModifiers(user, target, targetStrippable.HandStripDelay);
+
+ var prefix = stealth ? "stealthily " : "";
+ _adminLogger.Add(LogType.Stripping, LogImpact.Low, $"{ToPrettyString(user):actor} is trying to {prefix}place the item {ToPrettyString(held):item} in {ToPrettyString(target):target}'s hands");
+
+ var doAfterArgs = new DoAfterArgs(EntityManager, user, time, new StrippableDoAfterEvent(true, false, handName), user, target, held)
{
- ExtraCheck = Check,
- Hidden = ev.Stealth,
+ Hidden = stealth,
AttemptFrequency = AttemptFrequency.EveryTick,
BreakOnDamage = true,
BreakOnTargetMove = true,
BreakOnUserMove = true,
NeedHand = true,
- BreakOnHandChange = false, // allow simultaneously removing multiple items.
DuplicateCondition = DuplicateConditions.SameTool
};
- if (!ev.Stealth && Check())
+ _doAfterSystem.TryStartDoAfter(doAfterArgs);
+ }
+
+ ///
+ /// Places the item in the user's active hand into one of the target's hands.
+ ///
+ private void StripInsertHand(
+ Entity user,
+ Entity target,
+ EntityUid held,
+ string handName,
+ bool stealth)
+ {
+ if (!Resolve(user, ref user.Comp) ||
+ !Resolve(target, ref target.Comp))
+ return;
+
+ _handsSystem.TryDrop(user, checkActionBlocker: false, handsComp: user.Comp);
+ _handsSystem.TryPickup(target, held, handName, checkActionBlocker: false, animateUser: stealth, animate: stealth, handsComp: target.Comp);
+ _adminLogger.Add(LogType.Stripping, LogImpact.Medium, $"{ToPrettyString(user):actor} has placed the item {ToPrettyString(held):item} in {ToPrettyString(target):target}'s hands");
+
+ // Hand update will trigger strippable update.
+ }
+
+ ///
+ /// Checks whether the item is in the target's hand and whether it can be dropped.
+ ///
+ private bool CanStripRemoveHand(
+ EntityUid user,
+ Entity target,
+ EntityUid item,
+ string handName)
+ {
+ if (!Resolve(target, ref target.Comp))
+ return false;
+
+ if (!_handsSystem.TryGetHand(target, handName, out var handSlot, target.Comp))
{
- if (slotDef.StripHidden)
- {
- _popup.PopupEntity(Loc.GetString("strippable-component-alert-owner-hidden", ("slot", slot)), target,
- target, PopupType.Large);
- }
- else if (_inventorySystem.TryGetSlotEntity(strippable, slot, out var slotItem))
- {
- _popup.PopupEntity(Loc.GetString("strippable-component-alert-owner", ("user", Identity.Entity(user, EntityManager)), ("item", slotItem)), target,
- target, PopupType.Large);
- }
+ _popupSystem.PopupCursor(Loc.GetString("strippable-component-item-slot-free-message", ("owner", target)), user);
+ return false;
}
- var prefix = ev.Stealth ? "stealthily " : "";
- _adminLogger.Add(LogType.Stripping, LogImpact.Low, $"{ToPrettyString(user):actor} is trying to {prefix}strip the item {ToPrettyString(item):item} from {ToPrettyString(target):target}'s {slot} slot");
+ if (HasComp(handSlot.HeldEntity))
+ return false;
- var result = await _doAfter.WaitDoAfter(doAfterArgs);
- if (result != DoAfterStatus.Finished)
- return;
+ if (handSlot.HeldEntity == null)
+ return false;
- if (!_inventorySystem.TryUnequip(user, strippable, slot))
- return;
-
- // Raise a dropped event, so that things like gas tank internals properly deactivate when stripping
- RaiseLocalEvent(item, new DroppedEvent(user), true);
+ if (handSlot.HeldEntity != item)
+ return false;
- _handsSystem.PickupOrDrop(user, item, animateUser: !ev.Stealth, animate: !ev.Stealth);
- _adminLogger.Add(LogType.Stripping, LogImpact.Medium, $"{ToPrettyString(user):actor} has stripped the item {ToPrettyString(item):item} from {ToPrettyString(target):target}'s {slot} slot");
+ if (!_handsSystem.CanDropHeld(target, handSlot, false))
+ {
+ _popupSystem.PopupCursor(Loc.GetString("strippable-component-cannot-drop-message", ("owner", target)), user);
+ return false;
+ }
+ return true;
}
///
- /// Takes an item from a hand and places it in the user's active hand.
+ /// Begins a DoAfter to remove the item from the target's hand and insert it in the user's active hand.
///
- private async void TakeItemFromHands(EntityUid user, EntityUid target, EntityUid item, string handName, Entity strippable)
+ private void StartStripRemoveHand(
+ Entity user,
+ Entity target,
+ EntityUid item,
+ string handName,
+ StrippableComponent? targetStrippable = null)
{
- var hands = Comp(target);
- var userHands = Comp(user);
+ if (!Resolve(user, ref user.Comp) ||
+ !Resolve(target, ref target.Comp) ||
+ !Resolve(target, ref targetStrippable))
+ return;
- bool Check()
- {
- if (!_handsSystem.TryGetHand(target, handName, out var hand, hands) || hand.HeldEntity != item)
- {
- _popup.PopupCursor(Loc.GetString("strippable-component-item-slot-free-message",("owner", target)), user);
- return false;
- }
-
- if (HasComp(hand.HeldEntity))
- return false;
-
- if (!_handsSystem.CanDropHeld(target, hand, false))
- {
- _popup.PopupCursor(Loc.GetString("strippable-component-cannot-drop-message",("owner", target)), user);
- return false;
- }
-
- return true;
- }
+ if (!CanStripRemoveHand(user, target, item, handName))
+ return;
- var userEv = new BeforeStripEvent(strippable.Comp.HandStripDelay);
- RaiseLocalEvent(user, userEv);
- var ev = new BeforeGettingStrippedEvent(userEv.Time, userEv.Stealth);
- RaiseLocalEvent(target, ev);
+ var (time, stealth) = GetStripTimeModifiers(user, target, targetStrippable.HandStripDelay);
- var doAfterArgs = new DoAfterArgs(EntityManager, user, ev.Time, new AwaitedDoAfterEvent(), null, target: target, used: item)
+ if (!stealth)
+ _popupSystem.PopupEntity( Loc.GetString("strippable-component-alert-owner", ("user", Identity.Entity(user, EntityManager)), ("item", item)), target, target);
+
+ var prefix = stealth ? "stealthily " : "";
+ _adminLogger.Add(LogType.Stripping, LogImpact.Low, $"{ToPrettyString(user):actor} is trying to {prefix}strip the item {ToPrettyString(item):item} from {ToPrettyString(target):target}'s hands");
+
+ var doAfterArgs = new DoAfterArgs(EntityManager, user, time, new StrippableDoAfterEvent(false, false, handName), user, target, item)
{
- ExtraCheck = Check,
- Hidden = ev.Stealth,
+ Hidden = stealth,
AttemptFrequency = AttemptFrequency.EveryTick,
BreakOnDamage = true,
BreakOnTargetMove = true,
BreakOnUserMove = true,
NeedHand = true,
- BreakOnHandChange = false, // allow simultaneously removing multiple items.
+ BreakOnHandChange = false, // Allow simultaneously removing multiple items.
DuplicateCondition = DuplicateConditions.SameTool
};
- if (!ev.Stealth && Check() && _handsSystem.TryGetHand(target, handName, out var handSlot, hands) && handSlot.HeldEntity != null)
+ _doAfterSystem.TryStartDoAfter(doAfterArgs);
+ }
+
+ ///
+ /// Takes the item from the target's hand and inserts it in the user's active hand.
+ ///
+ private void StripRemoveHand(
+ Entity user,
+ Entity target,
+ EntityUid item,
+ bool stealth)
+ {
+ if (!Resolve(user, ref user.Comp) ||
+ !Resolve(target, ref target.Comp))
+ return;
+
+ _handsSystem.TryDrop(target, item, checkActionBlocker: false, handsComp: target.Comp);
+ _handsSystem.PickupOrDrop(user, item, animateUser: stealth, animate: stealth, handsComp: user.Comp);
+ _adminLogger.Add(LogType.Stripping, LogImpact.Medium, $"{ToPrettyString(user):actor} has stripped the item {ToPrettyString(item):item} from {ToPrettyString(target):target}'s hands");
+
+ // Hand update will trigger strippable update.
+ }
+
+ private void OnStrippableDoAfterRunning(Entity entity, ref DoAfterAttemptEvent ev)
+ {
+ var args = ev.DoAfter.Args;
+
+ DebugTools.Assert(entity.Owner == args.User);
+ DebugTools.Assert(args.Target != null);
+ DebugTools.Assert(args.Used != null);
+ DebugTools.Assert(ev.Event.SlotOrHandName != null);
+
+ if (ev.Event.InventoryOrHand)
{
- _popup.PopupEntity(
- Loc.GetString("strippable-component-alert-owner",
- ("user", Identity.Entity(user, EntityManager)), ("item", item)),
- strippable.Owner,
- strippable.Owner);
+ if ( ev.Event.InsertOrRemove && !CanStripInsertInventory((entity.Owner, entity.Comp), args.Target.Value, args.Used.Value, ev.Event.SlotOrHandName) ||
+ !ev.Event.InsertOrRemove && !CanStripRemoveInventory(entity.Owner, args.Target.Value, args.Used.Value, ev.Event.SlotOrHandName))
+ ev.Cancel();
}
+ else
+ {
+ if ( ev.Event.InsertOrRemove && !CanStripInsertHand((entity.Owner, entity.Comp), args.Target.Value, args.Used.Value, ev.Event.SlotOrHandName) ||
+ !ev.Event.InsertOrRemove && !CanStripRemoveHand(entity.Owner, args.Target.Value, args.Used.Value, ev.Event.SlotOrHandName))
+ ev.Cancel();
+ }
+ }
- var prefix = ev.Stealth ? "stealthily " : "";
- _adminLogger.Add(LogType.Stripping, LogImpact.Low,
- $"{ToPrettyString(user):actor} is trying to {prefix}strip the item {ToPrettyString(item):item} from {ToPrettyString(target):target}'s hands");
-
- var result = await _doAfter.WaitDoAfter(doAfterArgs);
- if (result != DoAfterStatus.Finished)
+ private void OnStrippableDoAfterFinished(Entity entity, ref StrippableDoAfterEvent ev)
+ {
+ if (ev.Cancelled)
return;
- _handsSystem.TryDrop(target, item, checkActionBlocker: false, handsComp: hands);
- _handsSystem.PickupOrDrop(user, item, animateUser: !ev.Stealth, animate: !ev.Stealth, handsComp: userHands);
- // hand update will trigger strippable update
- _adminLogger.Add(LogType.Stripping, LogImpact.Medium,
- $"{ToPrettyString(user):actor} has stripped the item {ToPrettyString(item):item} from {ToPrettyString(target):target}'s hands");
+ DebugTools.Assert(entity.Owner == ev.User);
+ DebugTools.Assert(ev.Target != null);
+ DebugTools.Assert(ev.Used != null);
+ DebugTools.Assert(ev.SlotOrHandName != null);
+
+ if (ev.InventoryOrHand)
+ {
+ if (ev.InsertOrRemove)
+ StripInsertInventory((entity.Owner, entity.Comp), ev.Target.Value, ev.Used.Value, ev.SlotOrHandName);
+ else StripRemoveInventory(entity.Owner, ev.Target.Value, ev.Used.Value, ev.SlotOrHandName, ev.Args.Hidden);
+ }
+ else
+ {
+ if (ev.InsertOrRemove)
+ StripInsertHand((entity.Owner, entity.Comp), ev.Target.Value, ev.Used.Value, ev.SlotOrHandName, ev.Args.Hidden);
+ else StripRemoveHand((entity.Owner, entity.Comp), ev.Target.Value, ev.Used.Value, ev.Args.Hidden);
+ }
}
}
}
diff --git a/Content.Shared/Clothing/EntitySystems/ToggleableClothingSystem.cs b/Content.Shared/Clothing/EntitySystems/ToggleableClothingSystem.cs
index 0138de7a98f..22a1d1a8f52 100644
--- a/Content.Shared/Clothing/EntitySystems/ToggleableClothingSystem.cs
+++ b/Content.Shared/Clothing/EntitySystems/ToggleableClothingSystem.cs
@@ -95,7 +95,7 @@ private void StartDoAfter(EntityUid user, EntityUid item, EntityUid wearer, Togg
if (component.StripDelay == null)
return;
- var (time, stealth) = _strippable.GetStripTimeModifiers(user, wearer, (float) component.StripDelay.Value.TotalSeconds);
+ var (time, stealth) = _strippable.GetStripTimeModifiers(user, wearer, component.StripDelay.Value);
var args = new DoAfterArgs(EntityManager, user, time, new ToggleClothingDoAfterEvent(), item, wearer, item)
{
diff --git a/Content.Shared/Inventory/InventoryTemplatePrototype.cs b/Content.Shared/Inventory/InventoryTemplatePrototype.cs
index a4779699629..585f80d4ce9 100644
--- a/Content.Shared/Inventory/InventoryTemplatePrototype.cs
+++ b/Content.Shared/Inventory/InventoryTemplatePrototype.cs
@@ -20,7 +20,7 @@ public sealed partial class SlotDefinition
[DataField("slotFlags")] public SlotFlags SlotFlags { get; private set; } = SlotFlags.PREVENTEQUIP;
[DataField("showInWindow")] public bool ShowInWindow { get; private set; } = true;
[DataField("slotGroup")] public string SlotGroup { get; private set; } = "Default";
- [DataField("stripTime")] public float StripTime { get; private set; } = 4f;
+ [DataField("stripTime")] public TimeSpan StripTime { get; private set; } = TimeSpan.FromSeconds(4f);
[DataField("uiWindowPos", required: true)]
public Vector2i UIWindowPosition { get; private set; }
diff --git a/Content.Shared/Strip/Components/StrippableComponent.cs b/Content.Shared/Strip/Components/StrippableComponent.cs
index fbf99992e3c..8bf09c3f4c6 100644
--- a/Content.Shared/Strip/Components/StrippableComponent.cs
+++ b/Content.Shared/Strip/Components/StrippableComponent.cs
@@ -1,3 +1,4 @@
+using Content.Shared.DoAfter;
using Content.Shared.Inventory;
using Robust.Shared.GameStates;
using Robust.Shared.Serialization;
@@ -8,10 +9,10 @@ namespace Content.Shared.Strip.Components
public sealed partial class StrippableComponent : Component
{
///
- /// The strip delay for hands.
+ /// The strip delay for hands.
///
[ViewVariables(VVAccess.ReadWrite), DataField("handDelay")]
- public float HandStripDelay = 4f;
+ public TimeSpan HandStripDelay = TimeSpan.FromSeconds(4f);
}
[NetSerializable, Serializable]
@@ -21,63 +22,63 @@ public enum StrippingUiKey : byte
}
[NetSerializable, Serializable]
- public sealed class StrippingSlotButtonPressed : BoundUserInterfaceMessage
+ public sealed class StrippingSlotButtonPressed(string slot, bool isHand) : BoundUserInterfaceMessage
{
- public readonly string Slot;
-
- public readonly bool IsHand;
-
- public StrippingSlotButtonPressed(string slot, bool isHand)
- {
- Slot = slot;
- IsHand = isHand;
- }
+ public readonly string Slot = slot;
+ public readonly bool IsHand = isHand;
}
[NetSerializable, Serializable]
- public sealed class StrippingEnsnareButtonPressed : BoundUserInterfaceMessage
- {
- public StrippingEnsnareButtonPressed()
- {
- }
- }
+ public sealed class StrippingEnsnareButtonPressed : BoundUserInterfaceMessage;
- public abstract class BaseBeforeStripEvent : EntityEventArgs, IInventoryRelayEvent
+ [ByRefEvent]
+ public abstract class BaseBeforeStripEvent(TimeSpan initialTime, bool stealth = false) : EntityEventArgs, IInventoryRelayEvent
{
- public readonly float InitialTime;
- public float Time => MathF.Max(InitialTime * Multiplier + Additive, 0f);
- public float Additive = 0;
- public float Multiplier = 1f;
- public bool Stealth;
+ public readonly TimeSpan InitialTime = initialTime;
+ public TimeSpan Multiplier = TimeSpan.FromSeconds(1f);
+ public TimeSpan Additive = TimeSpan.Zero;
+ public bool Stealth = stealth;
- public SlotFlags TargetSlots { get; } = SlotFlags.GLOVES;
+ public TimeSpan Time => TimeSpan.FromSeconds(MathF.Max(InitialTime.Seconds * Multiplier.Seconds + Additive.Seconds, 0f));
- public BaseBeforeStripEvent(float initialTime, bool stealth = false)
- {
- InitialTime = initialTime;
- Stealth = stealth;
- }
+ public SlotFlags TargetSlots { get; } = SlotFlags.GLOVES;
}
///
- /// Used to modify strip times. Raised directed at the user.
+ /// Used to modify strip times. Raised directed at the user.
///
///
- /// This is also used by some stripping related interactions, i.e., interactions with items that are currently equipped by another player.
+ /// This is also used by some stripping related interactions, i.e., interactions with items that are currently equipped by another player.
///
- public sealed class BeforeStripEvent : BaseBeforeStripEvent
- {
- public BeforeStripEvent(float initialTime, bool stealth = false) : base(initialTime, stealth) { }
- }
+ [ByRefEvent]
+ public sealed class BeforeStripEvent(TimeSpan initialTime, bool stealth = false) : BaseBeforeStripEvent(initialTime, stealth);
///
- /// Used to modify strip times. Raised directed at the target.
+ /// Used to modify strip times. Raised directed at the target.
///
///
- /// This is also used by some stripping related interactions, i.e., interactions with items that are currently equipped by another player.
+ /// This is also used by some stripping related interactions, i.e., interactions with items that are currently equipped by another player.
///
- public sealed class BeforeGettingStrippedEvent : BaseBeforeStripEvent
+ [ByRefEvent]
+ public sealed class BeforeGettingStrippedEvent(TimeSpan initialTime, bool stealth = false) : BaseBeforeStripEvent(initialTime, stealth);
+
+ ///
+ /// Organizes the behavior of DoAfters for .
+ ///
+ [Serializable, NetSerializable]
+ public sealed partial class StrippableDoAfterEvent : DoAfterEvent
{
- public BeforeGettingStrippedEvent(float initialTime, bool stealth = false) : base(initialTime, stealth) { }
+ public readonly bool InsertOrRemove;
+ public readonly bool InventoryOrHand;
+ public readonly string SlotOrHandName;
+
+ public StrippableDoAfterEvent(bool insertOrRemove, bool inventoryOrHand, string slotOrHandName)
+ {
+ InsertOrRemove = insertOrRemove;
+ InventoryOrHand = inventoryOrHand;
+ SlotOrHandName = slotOrHandName;
+ }
+
+ public override DoAfterEvent Clone() => this;
}
}
diff --git a/Content.Shared/Strip/Components/ThievingComponent.cs b/Content.Shared/Strip/Components/ThievingComponent.cs
index 83679f132c4..a851dd5ef63 100644
--- a/Content.Shared/Strip/Components/ThievingComponent.cs
+++ b/Content.Shared/Strip/Components/ThievingComponent.cs
@@ -11,7 +11,7 @@ public sealed partial class ThievingComponent : Component
///
[ViewVariables(VVAccess.ReadWrite)]
[DataField("stripTimeReduction")]
- public float StripTimeReduction = 0.5f;
+ public TimeSpan StripTimeReduction = TimeSpan.FromSeconds(0.5f);
///
/// Should it notify the user if they're stripping a pocket?
diff --git a/Content.Shared/Strip/SharedStrippableSystem.cs b/Content.Shared/Strip/SharedStrippableSystem.cs
index a698ae5035a..7afd4f245a1 100644
--- a/Content.Shared/Strip/SharedStrippableSystem.cs
+++ b/Content.Shared/Strip/SharedStrippableSystem.cs
@@ -14,12 +14,12 @@ public override void Initialize()
SubscribeLocalEvent(OnDragDrop);
}
- public (float Time, bool Stealth) GetStripTimeModifiers(EntityUid user, EntityUid target, float initialTime)
+ public (TimeSpan Time, bool Stealth) GetStripTimeModifiers(EntityUid user, EntityUid target, TimeSpan initialTime)
{
var userEv = new BeforeStripEvent(initialTime);
- RaiseLocalEvent(user, userEv);
+ RaiseLocalEvent(user, ref userEv);
var ev = new BeforeGettingStrippedEvent(userEv.Time, userEv.Stealth);
- RaiseLocalEvent(target, ev);
+ RaiseLocalEvent(target, ref ev);
return (ev.Time, ev.Stealth);
}
diff --git a/Content.Shared/Strip/ThievingSystem.cs b/Content.Shared/Strip/ThievingSystem.cs
index 0ef4b66571f..2b3d3b38a00 100644
--- a/Content.Shared/Strip/ThievingSystem.cs
+++ b/Content.Shared/Strip/ThievingSystem.cs
@@ -1,4 +1,5 @@
using Content.Shared.Inventory;
+using Content.Shared.Strip;
using Content.Shared.Strip.Components;
namespace Content.Shared.Strip;