Added a dungeon guardian easter egg.

Author: DavidF-Dev

CHANGELOG.md

@@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- Added an easter egg.
+
 ## [2.0.9] - 2023-12-02
 
 - Changed stinky easter to include chat messages (and other minor changes).

Code/Effects/WorldEffects/SpawnGuardian.cs

@@ -6,6 +6,7 @@
 using Microsoft.Xna.Framework;
 using Microsoft.Xna.Framework.Graphics;
 using Terraria;
+using Terraria.Audio;
 using Terraria.GameContent;
 using Terraria.ID;
 using Terraria.Localization;
@@ -52,15 +53,26 @@ public SpawnGuardian(bool isFake) : base(isFake ? EffectID.SpawnFakeGuardian : E
 
     protected override CrowdControlResponseStatus OnStart()
     {
+        var mode = CrowdControlGuardian.GuardianMode.None;
+        if (SteamUtils.IsTeebu)
+        {
+            mode |= CrowdControlGuardian.GuardianMode.Fishron;
+        }
+
+        if (SteamUtils.IsKulprid && !_isFake)
+        {
+            mode |= CrowdControlGuardian.GuardianMode.Persistent;
+        }
+
         if (NetUtils.IsSinglePlayer)
         {
             // In single-player, simply spawn the custom dungeon guardian
-            Spawn(GetLocalPlayer(), SteamUtils.IsTeebu);
+            Spawn(GetLocalPlayer(), mode);
         }
         else
         {
             // If on server, spawn on server (no need to pass arguments)
-            SendPacket(PacketID.HandleEffect, SteamUtils.IsTeebu);
+            SendPacket(PacketID.HandleEffect, (int)mode);
         }
 
         return CrowdControlResponseStatus.Success;
@@ -87,10 +99,10 @@ protected override void SendStartMessage(string viewerString, string playerStrin
     protected override void OnReceivePacket(CrowdControlPlayer player, BinaryReader reader)
     {
         // Spawn the dungeon guardian on the server
-        Spawn(player, reader.ReadBoolean());
+        Spawn(player, (CrowdControlGuardian.GuardianMode)reader.ReadInt32());
     }
 
-    private void Spawn(CrowdControlPlayer player, bool isTeebu)
+    private void Spawn(CrowdControlPlayer player, CrowdControlGuardian.GuardianMode mode)
     {
         // Determine spawn position
         var circleEdge = Main.rand.NextVector2CircularEdge(HalfRangeWidth, HalfRangeHeight);
@@ -107,7 +119,9 @@ private void Spawn(CrowdControlPlayer player, bool isTeebu)
         // Set whether it is fake or not
         var guardian = (CrowdControlGuardian)npc.ModNPC;
         guardian.IsFake = _isFake;
-        guardian.IsTeebu = isTeebu;
+        guardian.Mode = mode;
+        var isTeebu = guardian.IsFishron;
+        var isKulprid = guardian.IsPersistent;
 
         if (isTeebu)
         {
@@ -135,14 +149,14 @@ private void Spawn(CrowdControlPlayer player, bool isTeebu)
             NetMessage.SendData(MessageID.SyncNPC, -1, -1, null, index);
         }
 
-        if (!isTeebu)
+        if (!isTeebu && !isKulprid)
         {
             return;
         }
 
         // Special life for teebu
-        npc.lifeMax = 69420;
-        npc.life = 69420;
+        npc.lifeMax = isKulprid ? Main.hardMode ? 100 : 30 : 69420;
+        npc.life = npc.lifeMax;
 
         if (NetUtils.IsServer)
         {
@@ -157,6 +171,18 @@ private void Spawn(CrowdControlPlayer player, bool isTeebu)
     // ReSharper disable once ClassNeverInstantiated.Local
     private sealed class CrowdControlGuardian : ModNPC
     {
+        #region Enums
+
+        [Flags]
+        public enum GuardianMode
+        {
+            None = 0,
+            Fishron = 1,
+            Persistent = 2
+        }
+
+        #endregion
+
         #region Fields
 
         private int _timeLeft;
@@ -175,14 +201,24 @@ public bool IsFake
         }
 
         /// <summary>
-        ///     Whether the guardian is an easter egg for Teebu.
+        ///     Guardian mode.
         /// </summary>
-        public bool IsTeebu
+        public GuardianMode Mode
         {
-            get => NPC.ai[NPC.maxAI - 1] > 0f;
-            set => NPC.ai[NPC.maxAI - 1] = value ? 1f : 0f;
+            get => (GuardianMode)(int)NPC.ai[NPC.maxAI - 1];
+            set => NPC.ai[NPC.maxAI - 1] = (int)value;
         }
 
+        /// <summary>
+        ///     Uses a fishron overlay (Teebu easter egg).
+        /// </summary>
+        public bool IsFishron => Mode.HasFlag(GuardianMode.Fishron);
+
+        /// <summary>
+        ///     Doesn't despawn but has reduced life (Kulprid easter egg).
+        /// </summary>
+        public bool IsPersistent => Mode.HasFlag(GuardianMode.Persistent);
+
         public override string Texture => $"Terraria/Images/NPC_{NPCID.DungeonGuardian}";
 
         public override LocalizedText DisplayName => Lang.GetNPCName(NPCID.DungeonGuardian);
@@ -199,7 +235,7 @@ public bool IsTeebu
 
         public override void ModifyTypeName(ref string typeName)
         {
-            if (IsTeebu)
+            if (IsFishron)
             {
                 typeName = "Teebu's Favourite Boss";
             }
@@ -216,8 +252,49 @@ public override void SetDefaults()
         public override bool PreAI()
         {
             NPC.type = NPCID.DungeonGuardian;
-            NPC.ShowNameOnHover = NetUtils.IsSinglePlayer || !IsTeebu;
+            NPC.ShowNameOnHover = NetUtils.IsSinglePlayer || !IsFishron;
 
+            if (IsPersistent)
+            {
+                // Never run out of time if persistent
+                _timeLeft = 60 * SurvivalDuration;
+                NPC.timeLeft = 60 * SurvivalDuration + 1;
+
+                if (!NetUtils.IsServer && NPC.localAI[0] == 0f)
+                {
+                    NPC.localAI[0] = 1f;
+                    Roar();
+                }
+
+                // Ensure vanilla AI doesn't despawn the guardian if all players are dead
+                if (NPC.target < 0 || NPC.target >= Main.maxPlayers || !Main.player[NPC.target].active || Main.player[NPC.target].dead)
+                {
+                    NPC.target = -1;
+                    NPC.TargetClosest(false);
+                    if (NPC.target < 0 || NPC.target >= Main.maxPlayers || !Main.player[NPC.target].active || Main.player[NPC.target].dead)
+                    {
+                        NPC.target = -1;
+                        NPC.rotation %= MathF.PI * 2;
+                        NPC.rotation *= 0.95f;
+                        NPC.velocity *= 0.98f;
+                        return false;
+                    }
+
+                    // Reacquired a target, so roar!
+                    if (!NetUtils.IsServer)
+                    {
+                        Roar();
+                    }
+                }
+
+                // Move towards player (emulating vanilla behaviour)
+                var speedMult = NPC.DistanceSQ(Main.player[NPC.target].position) > 16 * 16 * 180 * 180 ? 5f : 1f;
+                NPC.velocity = NPC.DirectionTo(Main.player[NPC.target].position) * 8.75f * speedMult;
+                NPC.rotation += MathHelper.ToRadians(11);
+
+                return false;
+            }
+            
             // Reduce the time left timer
             _timeLeft--;
             if (_timeLeft != 0)
@@ -235,6 +312,22 @@ public override bool PreAI()
             return base.PreAI();
         }
 
+        public override bool CheckActive()
+        {
+            // Don't despawn if persistent
+            if (IsPersistent && _timeLeft > 0)
+            {
+                return false;
+            }
+
+            return base.CheckActive();
+        }
+
+        public override void OnKill()
+        {
+            Item.NewItem(null, NPC.position, NPC.width, NPC.height, ItemID.GoldCoin, 2);
+        }
+
         public override bool CanHitPlayer(Player target, ref int cooldownSlot)
         {
             // Ignore player if fake
@@ -249,15 +342,15 @@ public override bool CanHitNPC(NPC target)
 
         public override void BossHeadSlot(ref int index)
         {
-            if (IsTeebu)
+            if (IsFishron)
             {
                 index = NPCID.Sets.BossHeadTextures[NPCID.DukeFishron];
             }
         }
 
         public override bool PreDraw(SpriteBatch spriteBatch, Vector2 screenPos, Color drawColor)
         {
-            if (!IsTeebu)
+            if (!IsFishron)
             {
                 return base.PreDraw(spriteBatch, screenPos, drawColor);
             }
@@ -289,6 +382,12 @@ public override bool PreDraw(SpriteBatch spriteBatch, Vector2 screenPos, Color d
             return false;
         }
 
+        private void Roar()
+        {
+            var pos = Main.LocalPlayer.position + Main.LocalPlayer.DirectionTo(NPC.position) * 16f * 20f;
+            SoundEngine.PlaySound(SoundID.Roar with {SoundLimitBehavior = SoundLimitBehavior.ReplaceOldest}, pos);
+        }
+        
         #endregion
     }
 

Code/Utilities/SteamUtils.cs

@@ -24,6 +24,7 @@ public static class SteamUtils
     private static bool? _isMoonlightFaye;
     private static bool? _isMakenbacon;
     private static bool? _isPixyWixy;
+    private static bool? _isKulprid;
 
     #endregion
 
@@ -117,6 +118,11 @@ public static ulong SteamId
     ///     https://www.twitch.tv/pixywixy
     /// </summary>
     public static bool IsPixyWixy => CrowdControlConfig.GetInstance().ForceEasterEggs || (_isPixyWixy ?? (_isPixyWixy = SteamId == 76561198109975921UL).Value);
-    
+
+    /// <summary>
+    ///     https://www.twitch.tv/kulprid
+    /// </summary>
+    public static bool IsKulprid => CrowdControlConfig.GetInstance().ForceEasterEggs || (_isKulprid ?? (_isKulprid = SteamId == 76561198049559387UL).Value);
+
     #endregion
 }