Merge branch 'dev' into dream-tunnel-dash-state-check-overhaul

Author: aonkeeper4

GameBananaPage.html

@@ -21,5 +21,5 @@
 <br>
 <pre>
 - Name: CommunalHelper
-  Version: 1.22.0
+  Version: 1.23.0
 </pre>

Loenn/entities/misc/dream_tunnel_blocker.lua

@@ -0,0 +1,43 @@
+local triggers = require("triggers")
+local depths = require("consts.object_depths")
+local drawableRectangle = require("structs.drawable_rectangle")
+local drawableText = require("structs.drawable_text")
+local colors = require("consts.colors")
+
+local dreamTunnelBlocker = {}
+
+dreamTunnelBlocker.name = "CommunalHelper/DreamTunnelBlocker"
+dreamTunnelBlocker.depth = depths.fakeWalls + 2000;
+
+dreamTunnelBlocker.placements = {
+    name = "normal",
+    data = {
+        width = 16,
+        height = 16,
+        blockDreamTunnelDashes = true,
+        blockDreamDashes = false
+    }
+}
+
+-- adapted from triggers.getDrawable
+function dreamTunnelBlocker.sprite(room, entity)
+    local displayName = triggers.triggerText(room, entity)
+
+    local x = entity.x or 0
+    local y = entity.y or 0
+
+    local width = entity.width or 16
+    local height = entity.height or 16
+
+    local borderedRectangle = drawableRectangle.fromRectangle("bordered", x, y, width, height, colors.triggerColor, colors.triggerBorderColor)
+    local textDrawable = drawableText.fromText(displayName, x, y, width, height, nil, triggers.triggerFontSize, colors.triggerTextColor)
+
+    local drawables = borderedRectangle:getDrawableSprite()
+    table.insert(drawables, textDrawable)
+
+    textDrawable.depth = dreamTunnelBlocker.depth - 1
+
+    return drawables
+end
+
+return dreamTunnelBlocker

Loenn/entities/misc/glow_controller.lua

@@ -55,6 +55,8 @@ glowController.placements = {
             bloomRadius = 8.0,
             bloomOffsetX = 0,
             bloomOffsetY = 0,
+            deathAnimationIds = "death",
+            respawnAnimationIds = "respawn",
         },
     },
 }

Loenn/lang/en_gb.lang

@@ -821,6 +821,8 @@ entities.CommunalHelper/GlowController.attributes.description.bloomAlpha=The opa
 entities.CommunalHelper/GlowController.attributes.description.bloomRadius=The radius of the bloom in pixels.  Defaults to 8.
 entities.CommunalHelper/GlowController.attributes.description.bloomOffsetX=The X offset from the entity's position at which to place the BloomPoint.  Defaults to 0.
 entities.CommunalHelper/GlowController.attributes.description.bloomOffsetY=The Y offset from the entity's position at which to place the BloomPoint.  Defaults to 0.
+entities.CommunalHelper/GlowController.attributes.description.deathAnimationIds=A list of animation IDs to treat as "death" animations, that is, when the targeted entities' Sprites start playing one of these animations, their light/bloom will fade out.
+entities.CommunalHelper/GlowController.attributes.description.respawnAnimationIds=A list of animation IDs to treat as "respawn" animations, that is, when the targeted entities' Sprites start playing one of these animations, their light/bloom will fade back in.
 
 # Poison Gas
 entities.CommunalHelper/PoisonGas.placements.name.main=Poison Gas
@@ -979,6 +981,10 @@ entities.CommunalHelper/SJ/PelletEmitter.attributes.description.wiggleFrequency=
 entities.CommunalHelper/SJ/PelletEmitter.attributes.description.wiggleAmount=The amplitude of the wiggle. Defaults to 2. Set to 0 to disable wiggling, causing pellets to travel in a straight line.
 entities.CommunalHelper/SJ/PelletEmitter.attributes.description.wiggleHitbox=Whether or not the pellet hitbox should move following the wiggle.
 
+entities.CommunalHelper/DreamTunnelBlocker.placements.name.normal=Dream Tunnel Blocker
+entities.CommunalHelper/DreamTunnelBlocker.attributes.description.blockDreamTunnelDashes=Whether to prevent dream tunneling when dashing into a solid covered by this entity.
+entities.CommunalHelper/DreamTunnelBlocker.attributes.description.blockDreamDashes=Whether to prevent dream dashing when dashing into a dream block covered by this entity.
+
 # ---------------------- TRIGGERS --------------------------
 
 # [Strawberry Jam] Show Hitbox Trigger

Release Log.txt

@@ -1,3 +1,7 @@
+--1.23.0 (13/05/2025)--
+* Added Dream Tunnel Blockers. @SnipUndercover
+* Added death/respawn animation IDs options to Glow Controllers. @aonkeeper4
+
 --1.22.0 (27/04/2025)--
 * Implemented zoom-out support for PCTN-MRT rendering and Dream Sprite rendering. @bigkahuna443 & @earthwise01
 * Added 'noHole' option to Loop Blocks. @Spo0o0ky

src/DashStates/DreamTunnelDash/DreamTunnelDash.cs

@@ -1,9 +1,11 @@
 using Celeste.Mod.CommunalHelper.Components;
+using Celeste.Mod.CommunalHelper.Entities;
 using Celeste.Mod.CommunalHelper.States;
 using Mono.Cecil.Cil;
 using MonoMod.Cil;
 using MonoMod.RuntimeDetour;
 using MonoMod.Utils;
+using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
 
@@ -50,6 +52,8 @@ public static bool NextDashFeather
     public static Color[] DreamTrailColors;
     public static int DreamTrailColorIndex = 0;
 
+    // Keep a List<Entity> around to not allocate a new one every CollideAll<T>() call
+    private static List<Entity> dreamTunnelBlockers = new();
 
     private static IDetour hook_Player_DashCoroutine;
     private static IDetour hook_Player_orig_Update;
@@ -348,7 +352,14 @@ private static void Player_OnCollideV(ILContext il) {
 
     private static bool Player_DreamDashCheck(On.Celeste.Player.orig_DreamDashCheck orig, Player self, Vector2 dir)
     {
-        return overrideDreamDashCheck ? (overrideDreamDashCheck = false) : orig(self, dir);
+        if (overrideDreamDashCheck)
+            return overrideDreamDashCheck = false;
+
+        // Don't enter StDreamDash if there's a blocker
+        if (self.IsDreamDashBlocked(self.Position + dir))
+            return false;
+
+        return orig(self, dir);
     }
 
     // Fixes bug with dreamSfx soundsource not being stopped
@@ -698,6 +709,10 @@ private static bool DreamTunnelDashCheck(this Player player, Vector2 dir)
             if (player.Left + dir.X < bounds.Left || player.Right + dir.X > bounds.Right || player.Top + dir.Y < bounds.Top || player.Bottom + dir.Y > bounds.Bottom)
                 return false;
 
+            // Check if we're colliding with a DreamTunnelBlocker
+            if (player.IsDreamTunnelDashBlocked(player.Position + dir))
+                return false;
+
             Solid solid = null;
 
             // Check for dream blocks first, then for solids
@@ -779,6 +794,37 @@ private static bool DreamTunnelDashCheck(this Player player, Vector2 dir)
         return false;
     }
 
+    private static (bool blockDreamTunnelDashes, bool blockDreamDashes) GetBlockerConfiguration(this Player player, Vector2 position)
+    {
+        bool blockDreamTunnelDashes = false;
+        bool blockDreamDashes = false;
+
+        foreach (Entity e in player.CollideAll<DreamTunnelBlocker>(position, dreamTunnelBlockers))
+        {
+            if (e is DreamTunnelBlocker { BlockDreamTunnelDashes: true })
+                blockDreamTunnelDashes = true;
+            if (e is DreamTunnelBlocker { BlockDreamDashes: true })
+                blockDreamDashes = true;
+
+            if (blockDreamTunnelDashes && blockDreamDashes)
+                break;
+        }
+
+        return (blockDreamTunnelDashes, blockDreamDashes);
+    }
+
+    private static bool IsDreamTunnelDashBlocked(this Player player, Vector2 position)
+    {
+        return player.CollideAll<DreamTunnelBlocker>(position, dreamTunnelBlockers)
+            .Any(e => e is DreamTunnelBlocker { BlockDreamTunnelDashes: true });
+    }
+
+    private static bool IsDreamDashBlocked(this Player player, Vector2 position)
+    {
+        return player.CollideAll<DreamTunnelBlocker>(position, dreamTunnelBlockers)
+            .Any(e => e is DreamTunnelBlocker { BlockDreamDashes: true });
+    }
+
     #endregion
 
 }

src/Entities/Misc/DreamTunnelBlocker.cs

@@ -0,0 +1,20 @@
+namespace Celeste.Mod.CommunalHelper.Entities;
+
+[Tracked]
+[CustomEntity("CommunalHelper/DreamTunnelBlocker")]
+public class DreamTunnelBlocker : Entity
+{
+    public bool BlockDreamTunnelDashes;
+    public bool BlockDreamDashes;
+
+    /// Blocking behavior handled in <see cref="DashStates.DreamTunnelDash.DreamTunnelDashCheck" />
+    /// and <see cref="DashStates.DreamTunnelDash.Player_DreamDashCheck"/>
+    public DreamTunnelBlocker(EntityData data, Vector2 offset) : base(data.Position + offset)
+    {
+        Collider = new Hitbox(data.Width, data.Height);
+        Depth = Depths.FakeWalls + 2000;
+
+        BlockDreamTunnelDashes = data.Bool("blockDreamTunnelDashes", true);
+        BlockDreamDashes = data.Bool("blockDreamDashes", false);
+    }
+}

src/Entities/Misc/GlowController.cs

@@ -55,8 +55,8 @@ private static void IL_LightingRenderer_BeforeRender(ILContext il)
     private readonly float bloomRadius;
     private readonly Vector2 bloomOffset;
 
-    private const string DeathAnimationId = "death";
-    private const string RespawnAnimationId = "respawn";
+    private readonly string[] deathAnimationIds;
+    private readonly string[] respawnAnimationIds;
 
     public GlowController(EntityData data, Vector2 offset)
         : base(data.Position + offset)
@@ -74,6 +74,9 @@ public GlowController(EntityData data, Vector2 offset)
         bloomAlpha = data.Float("bloomAlpha", 1f);
         bloomRadius = data.Float("bloomRadius", 8f);
         bloomOffset = new Vector2(data.Int("bloomOffsetX"), data.Int("bloomOffsetY", -10));
+        
+        deathAnimationIds = data.Attr("deathAnimationIds", "death").Split(',');
+        respawnAnimationIds = data.Attr("respawnAnimationIds", "respawn").Split(',');
     }
 
     public override void Awake(Scene scene)
@@ -108,9 +111,9 @@ public override void Awake(Scene scene)
             }
 
             // some entities get a special coroutine that hides lights and blooms
-            // if it's a glider or otherwise has a sprite with a "death" animation
+            // if it's a glider or otherwise has a sprite with an animation id contained in `deathAnimationIds`
             if (requiresRemovalRoutine &&
-                entity.Components.GetAll<Sprite>().FirstOrDefault(s => s.Has(DeathAnimationId)) is { } sprite)
+                entity.Components.GetAll<Sprite>().FirstOrDefault(s => deathAnimationIds.Any(s.Has)) is { } sprite)
             {
                 entity.Add(new Coroutine(DeathRemovalRoutine(entity, sprite)));
             }
@@ -132,15 +135,15 @@ void SetAlpha(float alpha)
             }
         }
 
-        if (!sprite.Animations.TryGetValue(DeathAnimationId, out var deathAnimation))
+        if (sprite.Animations.FirstOrDefault(kvp => deathAnimationIds.Contains(kvp.Key)).Value is not {} deathAnimation)
         {
             yield break;
         }
 
         while (entity.Scene != null)
         {
             // wait until the sprite plays the death animation
-            while (entity.Scene != null && sprite.CurrentAnimationID != DeathAnimationId)
+            while (entity.Scene != null && !deathAnimationIds.Contains(sprite.CurrentAnimationID))
             {
                 yield return null;
             }
@@ -149,16 +152,17 @@ void SetAlpha(float alpha)
             var fadeTime = deathAnimation.Frames.Length * deathAnimation.Delay;
             var fadeRemaining = fadeTime;
 
-            while (entity.Scene != null && sprite.CurrentAnimationID == DeathAnimationId && fadeRemaining > 0)
+            while (entity.Scene != null && deathAnimationIds.Contains(sprite.CurrentAnimationID) && fadeRemaining > 0)
             {
                 fadeRemaining -= Engine.DeltaTime;
                 SetAlpha(Math.Max(fadeRemaining / fadeTime, 0f));
                 yield return null;
             }
+            SetAlpha(0f);
 
-            // if it's a respawning jelly, wait until the sprite is playing the respawn animation
-            if (!sprite.Animations.TryGetValue(RespawnAnimationId, out var respawnAnimation)) break;
-            while (entity.Scene != null && sprite.CurrentAnimationID != RespawnAnimationId)
+            // if the sprite has a respawn animation, wait until it's playing it
+            if (sprite.Animations.FirstOrDefault(kvp => respawnAnimationIds.Contains(kvp.Key)).Value is not {} respawnAnimation) break;
+            while (entity.Scene != null && !respawnAnimationIds.Contains(sprite.CurrentAnimationID))
             {
                 yield return null;
             }
@@ -167,12 +171,13 @@ void SetAlpha(float alpha)
             fadeTime = respawnAnimation.Frames.Length * respawnAnimation.Delay;
             fadeRemaining = fadeTime;
 
-            while (entity.Scene != null && sprite.CurrentAnimationID == RespawnAnimationId && fadeRemaining > 0)
+            while (entity.Scene != null && respawnAnimationIds.Contains(sprite.CurrentAnimationID) && fadeRemaining > 0)
             {
                 fadeRemaining -= Engine.DeltaTime;
                 SetAlpha(1f - Math.Max(fadeRemaining / fadeTime, 0f));
                 yield return null;
             }
+            SetAlpha(1f);
         }
     }
 }