Roundstart variation game rules (#24397)

* Raise `StationPostInitEvent` broadcast * Basic variation pass handling * standardize names + rule entities * why does it work like that? * add to defaults * light break variation pass * ent spawn entry * move some stationevent utility functions to gamerule + add one for finding random tile on specified station * forgot how statistics works * powered light variation pass is good now * station tile count function * public method to ensure all solutions (for procedural use before mapinit) * move gamerulesystem utility funcs to partial * ensure all solutions before spilling in puddlesystem. for use when spilling before mapinit * trash & puddle variation passes! * oh yeah * ehh lets live a little * std * utility for game rule check based on comp * entprotoid the trash spawner oops * generalize trash variation * use added instead of started for secret rule * random cleanup * generic replacement variation system * Wall rusting variation rule * account for modifying while enumerating * use localaabb * fix test * minor tweaks * reinforced wall replacer + puddletweaker
2024-01-30 22:52:35 -07:00
parent 1029142740
commit cc24ba6a31
37 changed files with 977 additions and 148 deletions
--- a/Content.Server/GameTicking/Rules/VariationPass/BaseEntityReplaceVariationPassSystem.cs
+++ b/Content.Server/GameTicking/Rules/VariationPass/BaseEntityReplaceVariationPassSystem.cs
@@ -0,0 +1,75 @@
+using Content.Server.GameTicking.Rules.VariationPass.Components;
+using Content.Shared.Storage;
+using Robust.Shared.Map;
+using Robust.Shared.Random;
+using Robust.Shared.Timing;
+
+namespace Content.Server.GameTicking.Rules.VariationPass;
+
+/// <inheritdoc cref="EntityReplaceVariationPassComponent"/>
+/// <summary>
+///     A base system for fast replacement of entities utilizing a query, rather than having to iterate every entity
+///     To use, you must have a marker component to use for <see cref="TEntComp"/>--each replaceable entity must have it
+///     Then you need an inheriting system as well as a unique game rule component for <see cref="TGameRuleComp"/>
+///
+///     This means a bit more boilerplate for each one, but significantly faster to actually execute.
+///     See <see cref="WallReplaceVariationPassSystem"/>
+/// </summary>
+public abstract class BaseEntityReplaceVariationPassSystem<TEntComp, TGameRuleComp> : VariationPassSystem<TGameRuleComp>
+    where TEntComp: IComponent
+    where TGameRuleComp: IComponent
+{
+    /// <summary>
+    ///     Used so we don't modify while enumerating
+    ///     if the replaced entity also has <see cref="TEntComp"/>.
+    ///
+    ///     Filled and cleared within the same tick so no persistence issues.
+    /// </summary>
+    private readonly Queue<(string, EntityCoordinates, Angle)> _queuedSpawns = new();
+
+    protected override void ApplyVariation(Entity<TGameRuleComp> ent, ref StationVariationPassEvent args)
+    {
+        if (!TryComp<EntityReplaceVariationPassComponent>(ent, out var pass))
+            return;
+
+        var stopwatch = new Stopwatch();
+        stopwatch.Start();
+
+        var replacementMod = Random.NextGaussian(pass.EntitiesPerReplacementAverage, pass.EntitiesPerReplacementStdDev);
+        var prob = (float) Math.Clamp(1 / replacementMod, 0f, 1f);
+
+        if (prob == 0)
+            return;
+
+        var enumerator = AllEntityQuery<TEntComp, TransformComponent>();
+        while (enumerator.MoveNext(out var uid, out _, out var xform))
+        {
+            if (!IsMemberOfStation((uid, xform), ref args))
+                continue;
+
+            if (RobustRandom.Prob(prob))
+                QueueReplace((uid, xform), pass.Replacements);
+        }
+
+        while (_queuedSpawns.TryDequeue(out var tup))
+        {
+            var (spawn, coords, rot) = tup;
+            var newEnt = Spawn(spawn, coords);
+            Transform(newEnt).LocalRotation = rot;
+        }
+
+        Log.Debug($"Entity replacement took {stopwatch.Elapsed} with {Stations.GetTileCount(args.Station)} tiles");
+    }
+
+    private void QueueReplace(Entity<TransformComponent> ent, List<EntitySpawnEntry> replacements)
+    {
+        var coords = ent.Comp.Coordinates;
+        var rot = ent.Comp.LocalRotation;
+        QueueDel(ent);
+
+        foreach (var spawn in EntitySpawnCollection.GetSpawns(replacements, RobustRandom))
+        {
+            _queuedSpawns.Enqueue((spawn, coords, rot));
+        }
+    }
+}