Files
wwdpublic/Content.Server/Storage/EntitySystems/BluespaceLockerSystem.cs
SimpleStation14 3b2a19d9ec Mirror: Code cleanup: Purge calls to obsolete EntityCoordinates methods (#289)
## Mirror of PR #26292: [Code cleanup: Purge calls to obsolete
EntityCoordinates
methods](https://github.com/space-wizards/space-station-14/pull/26292)
from <img src="https://avatars.githubusercontent.com/u/10567778?v=4"
alt="space-wizards" width="22"/>
[space-wizards](https://github.com/space-wizards)/[space-station-14](https://github.com/space-wizards/space-station-14)

###### `f4cb02fb0ca385c858569c07c51afb0d24ade949`

PR opened by <img
src="https://avatars.githubusercontent.com/u/85356?v=4" width="16"/><a
href="https://github.com/Tayrtahn"> Tayrtahn</a> at 2024-03-20 16:04:43
UTC

---

PR changed 34 files with 70 additions and 56 deletions.

The PR had the following labels:
- Status: Needs Review


---

<details open="true"><summary><h1>Original Body</h1></summary>

> <!-- Please read these guidelines before opening your PR:
https://docs.spacestation14.io/en/getting-started/pr-guideline -->
> <!-- The text between the arrows are comments - they will not be
visible on your PR. -->
> 
> ## About the PR
> <!-- What did you change in this PR? -->
> Cleaned up some outdated code.
> 
> ## Why / Balance
> <!-- Why was it changed? Link any discussions or issues here. Please
discuss how this would affect game balance. -->
> Clean code is happy code.
> 
> ## Technical details
> <!-- If this is a code change, summarize at high level how your new
code works. This makes it easier to review. -->
> Updated all calls to obsolete EntityCoordinates methods (ToMap,
ToMapPos, FromMap, ToVector2i, InRange) to non-obsolete ones (by passing
in SharedTransformSystem as an arg).
> 
> ## Media
> <!-- 
> PRs which make ingame changes (adding clothing, items, new features,
etc) are required to have media attached that showcase the changes.
> Small fixes/refactors are exempt.
> Any media may be used in SS14 progress reports, with clear credit
given.
> 
> If you're unsure whether your PR will require media, ask a maintainer.
> 
> Check the box below to confirm that you have in fact seen this (put an
X in the brackets, like [X]):
> -->
> Code
> - [X] I have added screenshots/videos to this PR showcasing its
changes ingame, **or** this PR does not require an ingame showcase
> 
> ## Breaking changes
> <!--
> List any breaking changes, including namespace, public
class/method/field changes, prototype renames; and provide instructions
for fixing them. This will be pasted in #codebase-changes.
> -->
> 
> **Changelog**
> <!--
> Make players aware of new features and changes that could affect how
they play the game by adding a Changelog entry. Please read the
Changelog guidelines located at:
https://docs.spacestation14.io/en/getting-started/pr-guideline#changelog
> -->
> 
> <!--
> Make sure to take this Changelog template out of the comment block in
order for it to show up.
> 🆑
> - add: Added fun!
> - remove: Removed fun!
> - tweak: Changed fun!
> - fix: Fixed fun!
> -->
> 


</details>

---------

Signed-off-by: VMSolidus <evilexecutive@gmail.com>
Co-authored-by: SimpleStation14 <Unknown>
Co-authored-by: VMSolidus <evilexecutive@gmail.com>
2024-05-28 23:36:53 -04:00

403 lines
16 KiB
C#

using System.Linq;
using Content.Server.Explosion.EntitySystems;
using Content.Server.Resist;
using Content.Server.Station.Components;
using Content.Server.Storage.Components;
using Content.Shared.Access.Components;
using Content.Shared.Coordinates;
using Content.Shared.DoAfter;
using Content.Shared.Lock;
using Content.Shared.Mind.Components;
using Content.Shared.Storage.Components;
using Content.Shared.Storage.EntitySystems;
using Content.Shared.Tools.Systems;
using Robust.Shared.Containers;
using Robust.Shared.Random;
using Robust.Shared.Timing;
namespace Content.Server.Storage.EntitySystems;
public sealed class BluespaceLockerSystem : EntitySystem
{
[Dependency] private readonly IRobustRandom _robustRandom = default!;
[Dependency] private readonly IGameTiming _timing = default!;
[Dependency] private readonly SharedContainerSystem _containerSystem = default!;
[Dependency] private readonly EntityStorageSystem _entityStorage = default!;
[Dependency] private readonly WeldableSystem _weldableSystem = default!;
[Dependency] private readonly LockSystem _lockSystem = default!;
[Dependency] private readonly SharedDoAfterSystem _doAfterSystem = default!;
[Dependency] private readonly SharedTransformSystem _transformSystem = default!;
[Dependency] private readonly ExplosionSystem _explosionSystem = default!;
public override void Initialize()
{
base.Initialize();
SubscribeLocalEvent<BluespaceLockerComponent, ComponentStartup>(OnStartup);
SubscribeLocalEvent<BluespaceLockerComponent, StorageBeforeOpenEvent>(PreOpen);
SubscribeLocalEvent<BluespaceLockerComponent, StorageAfterCloseEvent>(PostClose);
SubscribeLocalEvent<BluespaceLockerComponent, BluespaceLockerDoAfterEvent>(OnDoAfter);
}
private void OnStartup(EntityUid uid, BluespaceLockerComponent component, ComponentStartup args)
{
GetTarget(uid, component, true);
if (component.BehaviorProperties.BluespaceEffectOnInit)
BluespaceEffect(uid, component, component, true);
}
public void BluespaceEffect(EntityUid effectTargetUid, BluespaceLockerComponent effectSourceComponent, BluespaceLockerComponent? effectTargetComponent, bool bypassLimit = false)
{
if (!bypassLimit && Resolve(effectTargetUid, ref effectTargetComponent, false))
if (effectTargetComponent.BehaviorProperties.BluespaceEffectMinInterval > 0)
{
var curTimeTicks = _timing.CurTick.Value;
if (curTimeTicks < effectTargetComponent.BluespaceEffectNextTime)
return;
effectTargetComponent.BluespaceEffectNextTime = curTimeTicks + (uint) (_timing.TickRate * effectTargetComponent.BehaviorProperties.BluespaceEffectMinInterval);
}
Spawn(effectSourceComponent.BehaviorProperties.BluespaceEffectPrototype, effectTargetUid.ToCoordinates());
}
private void PreOpen(EntityUid uid, BluespaceLockerComponent component, ref StorageBeforeOpenEvent args)
{
EntityStorageComponent? entityStorageComponent = null;
int transportedEntities = 0;
if (!Resolve(uid, ref entityStorageComponent))
return;
if (!component.BehaviorProperties.ActOnOpen)
return;
// Select target
var target = GetTarget(uid, component);
if (target == null)
return;
// Close target if it is open
if (target.Value.storageComponent.Open)
_entityStorage.CloseStorage(target.Value.uid, target.Value.storageComponent);
// Apply bluespace effects if target is not a bluespace locker, otherwise let it handle it
if (target.Value.bluespaceLockerComponent == null)
{
// Move contained items
if (component.BehaviorProperties.TransportEntities || component.BehaviorProperties.TransportSentient)
foreach (var entity in target.Value.storageComponent.Contents.ContainedEntities.ToArray())
{
if (EntityManager.HasComponent<MindContainerComponent>(entity))
{
if (!component.BehaviorProperties.TransportSentient)
continue;
_containerSystem.Insert(entity, entityStorageComponent.Contents);
transportedEntities++;
}
else if (component.BehaviorProperties.TransportEntities)
{
_containerSystem.Insert(entity, entityStorageComponent.Contents);
transportedEntities++;
}
}
// Move contained air
if (component.BehaviorProperties.TransportGas)
{
entityStorageComponent.Air.CopyFromMutable(target.Value.storageComponent.Air);
target.Value.storageComponent.Air.Clear();
}
// Bluespace effects
if (component.BehaviorProperties.BluespaceEffectOnTeleportSource)
BluespaceEffect(target.Value.uid, component, target.Value.bluespaceLockerComponent);
if (component.BehaviorProperties.BluespaceEffectOnTeleportTarget)
BluespaceEffect(uid, component, component);
}
DestroyAfterLimit(uid, component, transportedEntities);
}
private bool ValidLink(EntityUid locker, EntityUid link, BluespaceLockerComponent lockerComponent, bool intendToLink = false)
{
if (!link.Valid ||
!TryComp<EntityStorageComponent>(link, out var linkStorage) ||
linkStorage.LifeStage == ComponentLifeStage.Deleted ||
link == locker)
return false;
if (lockerComponent.BehaviorProperties.InvalidateOneWayLinks &&
!(intendToLink && lockerComponent.AutoLinksBidirectional) &&
!(HasComp<BluespaceLockerComponent>(link) && Comp<BluespaceLockerComponent>(link).BluespaceLinks.Contains(locker)))
return false;
return true;
}
/// <returns>True if any HashSet in <paramref name="a"/> would grant access to <paramref name="b"/></returns>
private bool AccessMatch(IReadOnlyCollection<HashSet<string>>? a, IReadOnlyCollection<HashSet<string>>? b)
{
if ((a == null || a.Count == 0) && (b == null || b.Count == 0))
return true;
if (a != null && a.Any(aSet => aSet.Count == 0))
return true;
if (b != null && b.Any(bSet => bSet.Count == 0))
return true;
if (a != null && b != null)
return a.Any(aSet => b.Any(aSet.SetEquals));
return false;
}
private bool ValidAutolink(EntityUid locker, EntityUid link, BluespaceLockerComponent lockerComponent)
{
if (!ValidLink(locker, link, lockerComponent, true))
return false;
if (lockerComponent.PickLinksFromSameMap &&
link.ToCoordinates().GetMapId(EntityManager) != locker.ToCoordinates().GetMapId(EntityManager))
return false;
if (lockerComponent.PickLinksFromStationGrids &&
!HasComp<StationMemberComponent>(link.ToCoordinates().GetGridUid(EntityManager)))
return false;
if (lockerComponent.PickLinksFromResistLockers &&
!HasComp<ResistLockerComponent>(link))
return false;
if (lockerComponent.PickLinksFromSameAccess)
{
TryComp<AccessReaderComponent>(locker, out var sourceAccess);
TryComp<AccessReaderComponent>(link, out var targetAccess);
if (!AccessMatch(sourceAccess?.AccessLists, targetAccess?.AccessLists))
return false;
}
if (HasComp<BluespaceLockerComponent>(link))
{
if (lockerComponent.PickLinksFromNonBluespaceLockers)
return false;
}
else
{
if (lockerComponent.PickLinksFromBluespaceLockers)
return false;
}
return true;
}
public (EntityUid uid, EntityStorageComponent storageComponent, BluespaceLockerComponent? bluespaceLockerComponent)? GetTarget(EntityUid lockerUid, BluespaceLockerComponent component, bool init = false)
{
while (true)
{
// Ensure MinBluespaceLinks
if (component.BluespaceLinks.Count < component.MinBluespaceLinks)
{
// Get an shuffle the list of all EntityStorages
var storages = new List<Entity<EntityStorageComponent>>();
var query = EntityQueryEnumerator<EntityStorageComponent>();
while (query.MoveNext(out var uid, out var storage))
{
storages.Add((uid, storage));
}
_robustRandom.Shuffle(storages);
// Add valid candidates till MinBluespaceLinks is met
foreach (var storage in storages)
{
var potentialLink = storage.Owner;
if (!ValidAutolink(lockerUid, potentialLink, component))
continue;
component.BluespaceLinks.Add(potentialLink);
if (component.AutoLinksBidirectional || component.AutoLinksUseProperties)
{
var targetBluespaceComponent = CompOrNull<BluespaceLockerComponent>(potentialLink);
if (targetBluespaceComponent == null)
{
targetBluespaceComponent = AddComp<BluespaceLockerComponent>(potentialLink);
if (component.AutoLinksBidirectional)
targetBluespaceComponent.BluespaceLinks.Add(lockerUid);
if (component.AutoLinksUseProperties)
targetBluespaceComponent.BehaviorProperties = component.AutoLinkProperties with {};
GetTarget(potentialLink, targetBluespaceComponent, true);
BluespaceEffect(potentialLink, targetBluespaceComponent, targetBluespaceComponent, true);
}
else if (component.AutoLinksBidirectional)
{
targetBluespaceComponent.BluespaceLinks.Add(lockerUid);
}
}
if (component.BluespaceLinks.Count >= component.MinBluespaceLinks)
break;
}
}
// If there are no possible link targets and no links, return null
if (component.BluespaceLinks.Count == 0)
{
if (component.MinBluespaceLinks == 0 && !init)
RemComp<BluespaceLockerComponent>(lockerUid);
return null;
}
// Attempt to select, validate, and return a link
var links = component.BluespaceLinks.ToArray();
var link = links[_robustRandom.Next(0, component.BluespaceLinks.Count)];
if (ValidLink(lockerUid, link, component))
return (link, Comp<EntityStorageComponent>(link), CompOrNull<BluespaceLockerComponent>(link));
component.BluespaceLinks.Remove(link);
}
}
private void PostClose(EntityUid uid, BluespaceLockerComponent component, ref StorageAfterCloseEvent args)
{
PostClose(uid, component);
}
private void OnDoAfter(EntityUid uid, BluespaceLockerComponent component, DoAfterEvent args)
{
if (args.Handled || args.Cancelled)
return;
PostClose(uid, component, false);
args.Handled = true;
}
private void PostClose(EntityUid uid, BluespaceLockerComponent component, bool doDelay = true)
{
EntityStorageComponent? entityStorageComponent = null;
int transportedEntities = 0;
if (!Resolve(uid, ref entityStorageComponent))
return;
if (!component.BehaviorProperties.ActOnClose)
return;
// Do delay
if (doDelay && component.BehaviorProperties.Delay > 0)
{
EnsureComp<DoAfterComponent>(uid);
_doAfterSystem.TryStartDoAfter(new DoAfterArgs(EntityManager, uid, component.BehaviorProperties.Delay, new BluespaceLockerDoAfterEvent(), uid));
return;
}
// Select target
var target = GetTarget(uid, component);
if (target == null)
return;
// Move contained items
if (component.BehaviorProperties.TransportEntities || component.BehaviorProperties.TransportSentient)
foreach (var entity in entityStorageComponent.Contents.ContainedEntities.ToArray())
{
if (EntityManager.HasComponent<MindContainerComponent>(entity))
{
if (!component.BehaviorProperties.TransportSentient)
continue;
_containerSystem.Insert(entity, target.Value.storageComponent.Contents);
transportedEntities++;
}
else if (component.BehaviorProperties.TransportEntities)
{
_containerSystem.Insert(entity, target.Value.storageComponent.Contents);
transportedEntities++;
}
}
// Move contained air
if (component.BehaviorProperties.TransportGas)
{
target.Value.storageComponent.Air.CopyFromMutable(entityStorageComponent.Air);
entityStorageComponent.Air.Clear();
}
// Open and empty target
if (target.Value.storageComponent.Open)
{
_entityStorage.EmptyContents(target.Value.uid, target.Value.storageComponent);
_entityStorage.ReleaseGas(target.Value.uid, target.Value.storageComponent);
}
else
{
if (_weldableSystem.IsWelded(target.Value.uid))
{
// It gets bluespaced open...
_weldableSystem.SetWeldedState(target.Value.uid, false);
}
LockComponent? lockComponent = null;
if (Resolve(target.Value.uid, ref lockComponent, false) && lockComponent.Locked)
_lockSystem.Unlock(target.Value.uid, target.Value.uid, lockComponent);
_entityStorage.OpenStorage(target.Value.uid, target.Value.storageComponent);
}
// Bluespace effects
if (component.BehaviorProperties.BluespaceEffectOnTeleportSource)
BluespaceEffect(uid, component, component);
if (component.BehaviorProperties.BluespaceEffectOnTeleportTarget)
BluespaceEffect(target.Value.uid, component, target.Value.bluespaceLockerComponent);
DestroyAfterLimit(uid, component, transportedEntities);
}
private void DestroyAfterLimit(EntityUid uid, BluespaceLockerComponent component, int transportedEntities)
{
if (component.BehaviorProperties.DestroyAfterUsesMinItemsToCountUse > transportedEntities)
return;
if (component.BehaviorProperties.ClearLinksEvery != -1)
{
component.UsesSinceLinkClear++;
if (component.BehaviorProperties.ClearLinksEvery <= component.UsesSinceLinkClear)
{
if (component.BehaviorProperties.ClearLinksDebluespaces)
foreach (var link in component.BluespaceLinks)
RemComp<BluespaceLockerComponent>(link);
component.BluespaceLinks.Clear();
component.UsesSinceLinkClear = 0;
}
}
if (component.BehaviorProperties.DestroyAfterUses == -1)
return;
component.BehaviorProperties.DestroyAfterUses--;
if (component.BehaviorProperties.DestroyAfterUses > 0)
return;
switch (component.BehaviorProperties.DestroyType)
{
case BluespaceLockerDestroyType.Explode:
_explosionSystem.QueueExplosion(uid.ToCoordinates().ToMap(EntityManager, _transformSystem),
ExplosionSystem.DefaultExplosionPrototypeId, 4, 1, 2, maxTileBreak: 0);
goto case BluespaceLockerDestroyType.Delete;
case BluespaceLockerDestroyType.Delete:
QueueDel(uid);
break;
default:
case BluespaceLockerDestroyType.DeleteComponent:
RemComp<BluespaceLockerComponent>(uid);
break;
}
}
}