Bluespace locker event prep (#13397)

Content.Server/Storage/Components/BluespaceLockerComponent.cs

@@ -1,32 +1,16 @@
-namespace Content.Server.Storage.Components;
+using System.Threading;
+
+namespace Content.Server.Storage.Components;
 
 [RegisterComponent]
 public sealed class BluespaceLockerComponent : Component
 {
-    /// <summary>
-    /// Determines if gas will be transported.
-    /// </summary>
-    [DataField("transportGas"), ViewVariables(VVAccess.ReadWrite)]
-    public bool TransportGas = true;
-
-    /// <summary>
-    /// Determines if entities will be transported.
-    /// </summary>
-    [DataField("transportEntities"), ViewVariables(VVAccess.ReadWrite)]
-    public bool TransportEntities = true;
-
-    /// <summary>
-    /// Determines if entities with a Mind component will be transported.
-    /// </summary>
-    [DataField("allowSentient"), ViewVariables(VVAccess.ReadWrite)]
-    public bool AllowSentient = true;
-
     /// <summary>
     /// If length > 0, when something is added to the storage, it will instead be teleported to a random storage
     /// from the list and the other storage will be opened.
     /// </summary>
     [DataField("bluespaceLinks"), ViewVariables(VVAccess.ReadOnly)]
-    public HashSet<EntityStorageComponent> BluespaceLinks = new();
+    public HashSet<EntityUid> BluespaceLinks = new();
 
     /// <summary>
     /// Each time the system attempts to get a link, it will link additional lockers to ensure the minimum amount
@@ -54,8 +38,126 @@ public sealed class BluespaceLockerComponent : Component
     public bool PickLinksFromStationGrids = true;
 
     /// <summary>
-    /// Determines if links automatically added are bidirectional
+    /// Determines if links automatically added are restricted to having the same access
+    /// </summary>
+    [DataField("pickLinksFromSameAccess"), ViewVariables(VVAccess.ReadWrite)]
+    public bool PickLinksFromSameAccess = true;
+
+    /// <summary>
+    /// Determines if links automatically added are restricted to existing bluespace lockers
+    /// </summary>
+    [DataField("pickLinksFromBluespaceLockers"), ViewVariables(VVAccess.ReadWrite)]
+    public bool PickLinksFromBluespaceLockers;
+
+    /// <summary>
+    /// Determines if links automatically added are restricted to non-bluespace lockers
+    /// </summary>
+    [DataField("pickLinksFromNonBluespaceLockers"), ViewVariables(VVAccess.ReadWrite)]
+    public bool PickLinksFromNonBluespaceLockers = true;
+
+    public CancellationTokenSource? CancelToken;
+
+    /// <summary>
+    /// Determines if bluespace effect is show on component init
+    /// </summary>
+    [DataField("bluespaceEffectOnInit")]
+    public bool BluespaceEffectOnInit;
+
+    /// <summary>
+    /// Determines if links automatically added get the source locker set as a target
     /// </summary>
     [DataField("autoLinksBidirectional"), ViewVariables(VVAccess.ReadWrite)]
     public bool AutoLinksBidirectional;
+
+    /// <summary>
+    /// Determines if links automatically use <see cref="AutoLinkProperties"/>
+    /// </summary>
+    [DataField("autoLinksUseProperties"), ViewVariables(VVAccess.ReadWrite)]
+    public bool AutoLinksUseProperties;
+
+    public int UsesSinceLinkClear;
+
+    /// <summary>
+    /// Determines properties of automatically created links
+    /// </summary>
+    [DataField("autoLinkProperties"), ViewVariables(VVAccess.ReadOnly)]
+    public BluespaceLockerBehaviorProperties AutoLinkProperties = new();
+
+    /// <summary>
+    /// Determines properties of this locker
+    /// </summary>
+    [DataField("behaviorProperties"), ViewVariables(VVAccess.ReadOnly)]
+    public BluespaceLockerBehaviorProperties BehaviorProperties = new();
+}
+
+[DataDefinition]
+public record BluespaceLockerBehaviorProperties
+{
+    /// <summary>
+    /// Determines if gas will be transported.
+    /// </summary>
+    [DataField("transportGas"), ViewVariables(VVAccess.ReadWrite)]
+    public bool TransportGas { get; set; } = true;
+
+    /// <summary>
+    /// Determines if entities will be transported.
+    /// </summary>
+    [DataField("transportEntities"), ViewVariables(VVAccess.ReadWrite)]
+    public bool TransportEntities { get; set; } = true;
+
+    /// <summary>
+    /// Determines if entities with a Mind component will be transported.
+    /// </summary>
+    [DataField("transportSentient"), ViewVariables(VVAccess.ReadWrite)]
+    public bool TransportSentient { get; set; } = true;
+
+    /// <summary>
+    /// Delay to wait after closing before transporting
+    /// </summary>
+    [DataField("delay"), ViewVariables(VVAccess.ReadWrite)]
+    public float Delay { get; set; }
+
+    /// <summary>
+    /// Defines prototype to spawn for bluespace effect
+    /// </summary>
+    [DataField("bluespaceEffectPrototype"), ViewVariables(VVAccess.ReadWrite)]
+    public string BluespaceEffectPrototype { get; set; } = "EffectFlashBluespace";
+
+    /// <summary>
+    /// Determines if bluespace effect is show on teleport at the source
+    /// </summary>
+    [DataField("bluespaceEffectOnTeleportSource"), ViewVariables(VVAccess.ReadWrite)]
+    public bool BluespaceEffectOnTeleportSource { get; set; }
+
+    /// <summary>
+    /// Determines if bluespace effect is show on teleport at the target
+    /// </summary>
+    [DataField("bluespaceEffectOnTeleportTarget"), ViewVariables(VVAccess.ReadWrite)]
+    public bool BluespaceEffectOnTeleportTarget { get; set; }
+
+    /// <summary>
+    /// Uses left before the locker is destroyed. -1 indicates infinite
+    /// </summary>
+    [DataField("destroyAfterUses"), ViewVariables(VVAccess.ReadWrite)]
+    public int DestroyAfterUses { get; set; } = -1;
+
+    /// <summary>
+    /// How to destroy the locker after it runs out of uses
+    /// </summary>
+    [DataField("destroyType"), ViewVariables(VVAccess.ReadWrite)]
+    public BluespaceLockerDestroyType DestroyType { get; set; } = BluespaceLockerDestroyType.Delete;
+
+    /// <summary>
+    /// Uses left before the lockers links are cleared. -1 indicates infinite
+    /// </summary>
+    [DataField("clearLinksEvery"), ViewVariables(VVAccess.ReadWrite)]
+    public int ClearLinksEvery { get; set; } = -1;
+}
+
+[Flags]
+public enum BluespaceLockerDestroyType
+{
+    Delete,
+    DeleteComponent,
+    Explode,
 }