From 3261962f8c37a90c4fe0591b422d3b0bcf7a7523 Mon Sep 17 00:00:00 2001 From: Jezithyr Date: Sat, 6 Jan 2024 17:04:33 -0800 Subject: [PATCH] Fixing performance issue with Proximity Detector (#23557) * fixing access levels and removed strings from data defs * Fixing proximity detector performance - Re-added component filtering for the close entity search. - Changed criteria functionality to only allow for searching for entities with all specified comps (matching any would be too unperformant) --- .../Beeper/Components/BeeperComponent.cs | 12 +-- .../Components/ProximityDetectorComponent.cs | 12 ++- .../Systems/ProximityDetectionSystem.cs | 85 ++++++++++++++++--- 3 files changed, 87 insertions(+), 22 deletions(-) diff --git a/Content.Shared/Beeper/Components/BeeperComponent.cs b/Content.Shared/Beeper/Components/BeeperComponent.cs index fab7465d85..54d242709c 100644 --- a/Content.Shared/Beeper/Components/BeeperComponent.cs +++ b/Content.Shared/Beeper/Components/BeeperComponent.cs @@ -16,25 +16,25 @@ public sealed partial class BeeperComponent : Component /// /// Whether or not it's on. /// - [DataField("enabled")] + [DataField, AutoNetworkedField] public bool Enabled = true; /// /// How much to scale the interval by (< 0 = min, > 1 = max) /// - [DataField("intervalScaling"), ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] + [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] public FixedPoint2 IntervalScaling = 0; /// /// The maximum interval between beeps. /// - [DataField("maxBeepInterval"), ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] + [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] public TimeSpan MaxBeepInterval = TimeSpan.FromSeconds(1.5f); /// /// The minimum interval between beeps. /// - [DataField("minBeepInterval"), ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] + [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] public TimeSpan MinBeepInterval = TimeSpan.FromSeconds(0.25f); /// @@ -55,12 +55,12 @@ public sealed partial class BeeperComponent : Component /// /// Is the beep muted /// - [DataField("muted"), ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] + [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] public bool IsMuted = false; /// /// The sound played when the locator beeps. /// - [DataField("beepSound"), ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] + [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] public SoundSpecifier? BeepSound; } diff --git a/Content.Shared/ProximityDetection/Components/ProximityDetectorComponent.cs b/Content.Shared/ProximityDetection/Components/ProximityDetectorComponent.cs index 7a885ff19a..a46ea1a81f 100644 --- a/Content.Shared/ProximityDetection/Components/ProximityDetectorComponent.cs +++ b/Content.Shared/ProximityDetection/Components/ProximityDetectorComponent.cs @@ -13,10 +13,14 @@ public sealed partial class ProximityDetectorComponent : Component /// /// Whether or not it's on. /// - [DataField("enabled"), AutoNetworkedField, ViewVariables(VVAccess.ReadWrite)] + [DataField, AutoNetworkedField, ViewVariables(VVAccess.ReadWrite)] public bool Enabled = true; - [DataField("criteria", required: true), AutoNetworkedField, ViewVariables(VVAccess.ReadWrite)] + /// + /// The criteria used to filter entities + /// Note: RequireAll is only supported for tags, all components are required to count as a match! + /// + [DataField( required: true), AutoNetworkedField, ViewVariables(VVAccess.ReadWrite)] public EntityWhitelist Criteria = default!; /// @@ -35,11 +39,11 @@ public sealed partial class ProximityDetectorComponent : Component /// /// The farthest distance to search for targets /// - [DataField("range"), ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] + [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] public FixedPoint2 Range = 10f; public float AccumulatedFrameTime; - [DataField("updateRate"), ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] + [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField] public float UpdateRate = 0.3f; } diff --git a/Content.Shared/ProximityDetection/Systems/ProximityDetectionSystem.cs b/Content.Shared/ProximityDetection/Systems/ProximityDetectionSystem.cs index 4b255e4a5c..db25e8bc51 100644 --- a/Content.Shared/ProximityDetection/Systems/ProximityDetectionSystem.cs +++ b/Content.Shared/ProximityDetection/Systems/ProximityDetectionSystem.cs @@ -1,4 +1,5 @@ using Content.Shared.ProximityDetection.Components; +using Content.Shared.Tag; using Robust.Shared.Network; namespace Content.Shared.ProximityDetection.Systems; @@ -9,6 +10,7 @@ public sealed class ProximityDetectionSystem : EntitySystem { [Dependency] private readonly EntityLookupSystem _entityLookup = default!; [Dependency] private readonly SharedTransformSystem _transform = default!; + [Dependency] private readonly TagSystem _tagSystem = default!; [Dependency] private readonly INetManager _net = default!; //update is only run on the server @@ -17,18 +19,27 @@ public sealed class ProximityDetectionSystem : EntitySystem { SubscribeLocalEvent(OnPaused); SubscribeLocalEvent(OnUnpaused); + SubscribeLocalEvent(OnCompInit); + } - protected void OnPaused(EntityUid owner, ProximityDetectorComponent component, EntityPausedEvent args) + private void OnCompInit(EntityUid uid, ProximityDetectorComponent component, ComponentInit args) + { + if (component.Criteria.RequireAll) + return; + Log.Debug("DetectorComponent only supports requireAll = false for tags. All components are required for a match!"); + } + + private void OnPaused(EntityUid owner, ProximityDetectorComponent component, EntityPausedEvent args) { SetEnable_Internal(owner,component,false); } - protected void OnUnpaused(EntityUid owner, ProximityDetectorComponent detector, ref EntityUnpausedEvent args) + private void OnUnpaused(EntityUid owner, ProximityDetectorComponent detector, ref EntityUnpausedEvent args) { SetEnable_Internal(owner, detector,true); } - protected internal void SetEnable(EntityUid owner, bool enabled, ProximityDetectorComponent? detector = null) + public void SetEnable(EntityUid owner, bool enabled, ProximityDetectorComponent? detector = null) { if (!Resolve(owner, ref detector) || detector.Enabled == enabled) return; @@ -52,12 +63,12 @@ public sealed class ProximityDetectionSystem : EntitySystem } } - protected internal bool GetEnable(EntityUid owner, ProximityDetectorComponent? detector = null) + public bool GetEnable(EntityUid owner, ProximityDetectorComponent? detector = null) { return Resolve(owner, ref detector, false) && detector.Enabled; } - protected void SetEnable_Internal(EntityUid owner,ProximityDetectorComponent detector, bool enabled) + private void SetEnable_Internal(EntityUid owner,ProximityDetectorComponent detector, bool enabled) { detector.Enabled = enabled; var noDetectEvent = new ProximityTargetUpdatedEvent(detector, detector.TargetEnt, detector.Distance); @@ -72,7 +83,7 @@ public sealed class ProximityDetectionSystem : EntitySystem RunUpdate_Internal(owner, detector); } - protected void ForceUpdate(EntityUid owner, ProximityDetectorComponent? detector = null) + public void ForceUpdate(EntityUid owner, ProximityDetectorComponent? detector = null) { if (!Resolve(owner, ref detector)) return; @@ -80,17 +91,37 @@ public sealed class ProximityDetectionSystem : EntitySystem } - protected void RunUpdate_Internal(EntityUid owner,ProximityDetectorComponent detector) + private void RunUpdate_Internal(EntityUid owner,ProximityDetectorComponent detector) { if (!_net.IsServer) //only run detection checks on the server! return; var xformQuery = GetEntityQuery(); var xform = xformQuery.GetComponent(owner); List<(EntityUid TargetEnt, float Distance)> detections = new(); - foreach (var ent in _entityLookup.GetEntitiesInRange(_transform.GetMapCoordinates(owner, xform), - detector.Range.Float())) + + if (detector.Criteria.Components == null) { - if (!detector.Criteria.IsValid(ent, EntityManager)) + Log.Error($"ProximityDetectorComponent on {ToPrettyString(owner)} must use at least 1 component as a filter in criteria!"); + throw new ArgumentException($"ProximityDetectorComponent on {ToPrettyString(owner)} must use at least 1 component as a filter in criteria!"); + } + var firstCompType = EntityManager.ComponentFactory.GetRegistration(detector.Criteria.Components[0]).Type; + var foundEnts = _entityLookup.GetEntitiesInRange(firstCompType,_transform.GetMapCoordinates(owner, xform), detector.Range.Float()); + + var tagSearchEnabled = detector.Criteria.Tags is {Count: > 0}; + + CheckForAllComponentsPresent(detector, ref foundEnts, tagSearchEnabled); + + if (foundEnts.Count == 0) + { + UpdateTargetFromClosest(owner, detector, detections); + return; + } + + foreach (var ent in foundEnts) + { + if (tagSearchEnabled && ent.Comp is TagComponent tags && (detector.Criteria.RequireAll + ? _tagSystem.HasAllTags(tags, detector.Criteria.Tags!) + : _tagSystem.HasAnyTag(tags, detector.Criteria.Tags!))) continue; var distance = (_transform.GetWorldPosition(xform, xformQuery) - _transform.GetWorldPosition(ent, xformQuery)).Length(); if (CheckDetectConditions(ent, distance, owner, detector)) @@ -101,14 +132,44 @@ public sealed class ProximityDetectionSystem : EntitySystem UpdateTargetFromClosest(owner, detector, detections); } - protected bool CheckDetectConditions(EntityUid targetEntity, float dist, EntityUid owner, ProximityDetectorComponent detector) + private void CheckForAllComponentsPresent(ProximityDetectorComponent detector, ref HashSet> foundEnts, bool tagSearchEnabled) + { + var validEnts = new HashSet>(foundEnts.Count); + for (var i = 1; i < detector.Criteria.Components!.Length; i++) + { + validEnts.Clear(); + var compType = EntityManager.ComponentFactory.GetRegistration(detector.Criteria.Components[i]).Type; + foreach (var ent in foundEnts) + { + if (!HasComp(ent, compType)) + continue; + validEnts.Add(ent); + } + (foundEnts, validEnts) = (validEnts, foundEnts); + } + validEnts.Clear(); + if (tagSearchEnabled) + { + foreach (var ent in foundEnts) + { + if (!HasComp(ent)) + continue; + validEnts.Add(ent); + } + (foundEnts, validEnts) = (validEnts, foundEnts); + validEnts.Clear(); + } + } + + + private bool CheckDetectConditions(EntityUid targetEntity, float dist, EntityUid owner, ProximityDetectorComponent detector) { var detectAttempt = new ProximityDetectionAttemptEvent(false, dist, (owner, detector)); RaiseLocalEvent(targetEntity, ref detectAttempt); return !detectAttempt.Cancel; } - protected void UpdateTargetFromClosest(EntityUid owner, ProximityDetectorComponent detector, List<(EntityUid TargetEnt, float Distance)> detections) + private void UpdateTargetFromClosest(EntityUid owner, ProximityDetectorComponent detector, List<(EntityUid TargetEnt, float Distance)> detections) { if (detections.Count == 0) {