Merge pull request CommunalHelper#227 from aonkeeper4/debrisless-entities

Add option to remove debris to all move block types

Author: catapillie

Loenn/entities/cassette_blocks/cassette_move_block.lua

@@ -52,6 +52,7 @@ for i = 1, 4 do
             crashTime = 0.15,
             regenTime = 3.0,
             shakeOnCollision = true,
+            noDebris = false,
         }
     }
 end

Loenn/entities/connected_blocks/connected_move_block.lua

@@ -60,6 +60,7 @@ for i, direction in ipairs(enums.move_block_directions) do
             crashTime = 0.15,
             regenTime = 3.0,
             shakeOnCollision = true,
+            noDebris = false,
         }
     }
 end
@@ -80,6 +81,7 @@ connectedMoveBlock.placements[5] = {
         crashTime = 0.15,
         regenTime = 3.0,
         shakeOnCollision = true,
+        noDebris = false,
     }
 }
 connectedMoveBlock.placements[6] = {
@@ -99,6 +101,7 @@ connectedMoveBlock.placements[6] = {
         crashTime = 0.15,
         regenTime = 3.0,
         shakeOnCollision = true,
+        noDebris = false,
         activatorFlags = "_pressed",
         breakerFlags = "_obstructed",
         onActivateFlags = "",

Loenn/entities/connected_blocks/equation_move_block.lua

@@ -81,6 +81,7 @@ for i, direction in ipairs(enums.move_block_directions) do
             crashTime = 0.15,
             regenTime = 3.0,
             shakeOnCollision = true,
+            noDebris = false,
         }
     }
 end
@@ -103,6 +104,7 @@ equationMoveBlock.placements[5] = {
         crashTime = 0.15,
         regenTime = 3.0,
         shakeOnCollision = true,
+        noDebris = false,
     }
 }
 equationMoveBlock.placements[6] = {
@@ -124,6 +126,7 @@ equationMoveBlock.placements[6] = {
         crashTime = 0.15,
         regenTime = 3.0,
         shakeOnCollision = true,
+        noDebris = false,
         activatorFlags = "_pressed",
         breakerFlags = "_obstructed",
         onActivateFlags = "",

Loenn/entities/dream_blocks/dream_move_block.lua

@@ -73,6 +73,7 @@ dreamMoveBlock.placements = {
             crashTime = 0.15,
             regenTime = 3.0,
             shakeOnCollision = true,
+            noDebris = false,
             idleButtonsColor = "FFFFFF",
             movingButtonsColor = "FFFFFF",
             idleArrowColor = "FFFFFF",

Loenn/entities/misc/move_swap_block.lua

@@ -46,6 +46,7 @@ moveSwapBlock.placements = {
             crashTime = 0.15,
             regenTime = 3.0,
             shakeOnCollision = true,
+            noDebris = false,
         }
     }
 }

Loenn/lang/en_gb.lang

@@ -189,6 +189,7 @@ entities.CommunalHelper/CassetteMoveBlock.attributes.name.regenTime=Respawn Time
 entities.CommunalHelper/CassetteMoveBlock.attributes.description.crashTime=The time it takes for this Cassette Move Block to break when hitting a solid in seconds.
 entities.CommunalHelper/CassetteMoveBlock.attributes.description.regenTime=The time it takes for this Cassette Move Block to respawn after breaking in seconds.
 entities.CommunalHelper/CassetteMoveBlock.attributes.description.shakeOnCollision=Whether this Cassette Move Block should start shaking if it collides with a solid for longer than the default break time.
+entities.CommunalHelper/CassetteMoveBlock.attributes.description.noDebris=Whether this Cassette Move Block should not spawn debris when it breaks.
 
 # Cassette Swap Block
 entities.CommunalHelper/CassetteSwapBlock.placements.name.cassette_block_0=Cassette Swap Block (0 - Blue)
@@ -318,6 +319,7 @@ entities.CommunalHelper/DreamMoveBlock.attributes.name.regenTime=Respawn Time
 entities.CommunalHelper/DreamMoveBlock.attributes.description.crashTime=The time it takes for this Dream Move Block to break when hitting a solid in seconds.
 entities.CommunalHelper/DreamMoveBlock.attributes.description.regenTime=The time it takes for this Dream Move Block to respawn after breaking in seconds.
 entities.CommunalHelper/DreamMoveBlock.attributes.description.shakeOnCollision=Whether this Dream Move Block should start shaking if it collides with a solid for longer than the default break time.
+entities.CommunalHelper/DreamMoveBlock.attributes.description.noDebris=Whether this Dream Move Block should not spawn debris when it breaks.
 entities.CommunalHelper/DreamMoveBlock.Attributes.description.idleButtonsColor=Body and buttons's color when the block is idle.
 entities.CommunalHelper/DreamMoveBlock.Attributes.description.idleArrowColor=Arrow's color when the block is idle.
 entities.CommunalHelper/DreamMoveBlock.Attributes.description.idleWobbleLinesColor=Wobble lines's color when the block is idle.
@@ -430,6 +432,7 @@ entities.CommunalHelper/ConnectedMoveBlock.attributes.name.regenTime=Respawn Tim
 entities.CommunalHelper/ConnectedMoveBlock.attributes.description.crashTime=The time it takes for this Connected Move Block to break when hitting a solid in seconds.
 entities.CommunalHelper/ConnectedMoveBlock.attributes.description.regenTime=The time it takes for this Connected Move Block to respawn after breaking in seconds.
 entities.CommunalHelper/ConnectedMoveBlock.attributes.description.shakeOnCollision=Whether this Connected Move Block should start shaking if it collides with a solid for longer than the default break time.
+entities.CommunalHelper/ConnectedMoveBlock.attributes.description.noDebris=Whether this Connected Move Block should not spawn debris when it breaks.
 
 # Connected Temple Cracked Block
 entities.CommunalHelper/ConnectedTempleCrackedBlock.placements.name.normal=Connected Temple Cracked Block
@@ -464,6 +467,7 @@ entities.CommunalHelper/EquationMoveBlock.attributes.name.regenTime=Respawn Time
 entities.CommunalHelper/EquationMoveBlock.attributes.description.crashTime=The time it takes for this Equation Move Block to break when hitting a solid in seconds.
 entities.CommunalHelper/EquationMoveBlock.attributes.description.regenTime=The time it takes for this Equation Move Block to respawn after breaking in seconds.
 entities.CommunalHelper/EquationMoveBlock.attributes.description.shakeOnCollision=Whether this Equation Move Block should start shaking if it collides with a solid for longer than the default break time.
+entities.CommunalHelper/EquationMoveBlock.attributes.description.noDebris=Whether this Equation Move Block should not spawn debris when it breaks.
 
 # Bouncy Panel
 entities.CommunalHelper/BouncyPanel.placements.name.up=Bouncy Panel (Up)
@@ -608,6 +612,7 @@ entities.CommunalHelper/MoveSwapBlock.attributes.name.regenTime=Respawn Time
 entities.CommunalHelper/MoveSwapBlock.attributes.description.crashTime=The time it takes for this Move Swap Block to break when hitting a solid in seconds.
 entities.CommunalHelper/MoveSwapBlock.attributes.description.regenTime=The time it takes for this Move Swap Block to respawn after breaking in seconds.
 entities.CommunalHelper/MoveSwapBlock.attributes.description.shakeOnCollision=Whether this Move Swap Block should start shaking if it collides with a solid for longer than the default break time.
+entities.CommunalHelper/MoveSwapBlock.attributes.description.noDebris=Whether this Move Swap Block should not spawn debris when it breaks.
 
 # Player Bubble Region
 entities.CommunalHelper/PlayerBubbleRegion.placements.name.player_bubble_region=Player Bubble Region

src/Entities/CassetteBlocks/CassetteMoveBlock.cs

@@ -3,6 +3,7 @@
 using MonoMod.Utils;
 using System.Collections;
 using System.Collections.Generic;
+using System.Linq;
 using Directions = Celeste.MoveBlock.Directions;
 
 // TODO
@@ -59,7 +60,9 @@ public class CassetteMoveBlock : CustomCassetteBlock
     private readonly ParticleType P_Break;
     private readonly ParticleType P_BreakPressed;
 
-    public CassetteMoveBlock(Vector2 position, EntityID id, int width, int height, Directions direction, float moveSpeed, int index, float tempo, bool oldConnectionBehavior, Color? overrideColor, float crashTime, float regenTime, bool shakeOnCollision)
+    private readonly bool noDebris;
+
+    public CassetteMoveBlock(Vector2 position, EntityID id, int width, int height, Directions direction, float moveSpeed, int index, float tempo, bool oldConnectionBehavior, Color? overrideColor, float crashTime, float regenTime, bool shakeOnCollision, bool noDebris)
         : base(position, id, width, height, index, tempo, true, oldConnectionBehavior, dynamicHitbox: true, overrideColor)
     {
         startPosition = position;
@@ -82,6 +85,8 @@ public CassetteMoveBlock(Vector2 position, EntityID id, int width, int height, D
         P_Break = new ParticleType(MoveBlock.P_Break) { Color = color };
         P_BreakPressed = new ParticleType(MoveBlock.P_Break) { Color = pressedColor };
 
+        this.noDebris = noDebris;
+
         DynamicData dynamicData = new(this);
         Add(new MoveBlockRedirectable(
             dynamicData,
@@ -116,7 +121,7 @@ public CassetteMoveBlock(Vector2 position, EntityID id, int width, int height, D
     }
 
     public CassetteMoveBlock(EntityData data, Vector2 offset, EntityID id)
-        : this(data.Position + offset, id, data.Width, data.Height, data.Enum("direction", Directions.Left), data.Bool("fast") ? FastMoveSpeed : data.Float("moveSpeed", MoveSpeed), data.Int("index"), data.Float("tempo", 1f), data.Bool("oldConnectionBehavior", true), data.HexColorNullable("customColor"), data.Float("crashTime", 0.15f), data.Float("regenTime", 3f), data.Bool("shakeOnCollision", true))
+        : this(data.Position + offset, id, data.Width, data.Height, data.Enum("direction", Directions.Left), data.Bool("fast") ? FastMoveSpeed : data.Float("moveSpeed", MoveSpeed), data.Int("index"), data.Float("tempo", 1f), data.Bool("oldConnectionBehavior", true), data.HexColorNullable("customColor"), data.Float("crashTime", 0.15f), data.Float("regenTime", 3f), data.Bool("shakeOnCollision", true), data.Bool("noDebris"))
     {
     }
 
@@ -260,19 +265,21 @@ private IEnumerator Controller()
             BreakParticles();
             ((MoveBlockRedirectable) Get<Redirectable>())?.ResetBlock();
             List<MoveBlockDebris> debris = new();
-            for (int x = 0; x < Width; x += 8)
-            {
-                for (int y = 0; y < Height; y += 8)
+            if (!noDebris) {
+                for (int x = 0; x < Width; x += 8)
                 {
-                    Vector2 offset = new(x + 4f, y + 4f);
-
-                    MoveBlockDebris d = Engine.Pooler.Create<MoveBlockDebris>().Init(Position + offset, Center, startPosition + offset, spr =>
+                    for (int y = 0; y < Height; y += 8)
                     {
-                        spr.Color = Activated ? color : pressedColor;
-                    });
-                    d.Sprite.Texture = Calc.Random.Choose(GFX.Game.GetAtlasSubtextures("objects/CommunalHelper/cassetteMoveBlock/debris"));
-                    debris.Add(d);
-                    Scene.Add(d);
+                        Vector2 offset = new(x + 4f, y + 4f);
+
+                        MoveBlockDebris d = Engine.Pooler.Create<MoveBlockDebris>().Init(Position + offset, Center, startPosition + offset, spr =>
+                        {
+                            spr.Color = Activated ? color : pressedColor;
+                        });
+                        d.Sprite.Texture = Calc.Random.Choose(GFX.Game.GetAtlasSubtextures("objects/CommunalHelper/cassetteMoveBlock/debris"));
+                        debris.Add(d);
+                        Scene.Add(d);
+                    }
                 }
             }
             Vector2 newPosition = startPosition + blockOffset;
@@ -297,7 +304,7 @@ private IEnumerator Controller()
                 yield return null;
 
             Present = true;
-            EventInstance sound = Audio.Play(SFX.game_04_arrowblock_reform_begin, debris[0].Position);
+            EventInstance sound = Audio.Play(SFX.game_04_arrowblock_reform_begin, debris.FirstOrDefault()?.Position ?? Center);
             Coroutine component;
             Coroutine routine = component = new Coroutine(SoundFollowsDebrisCenter(sound, debris));
             Add(component);
@@ -336,7 +343,7 @@ private IEnumerator Controller()
 
     private IEnumerator SoundFollowsDebrisCenter(EventInstance instance, List<MoveBlockDebris> debris)
     {
-        while (true)
+        while (true && debris.Count > 0)
         {
             instance.getPlaybackState(out PLAYBACK_STATE state);
             if (state == PLAYBACK_STATE.STOPPED)

src/Entities/ConnectedBlocks/ConnectedMoveBlock.cs

@@ -126,6 +126,8 @@ public override void Render()
 
     private readonly bool outline;
 
+    protected readonly bool noDebris;
+
     public ConnectedMoveBlock(EntityData data, Vector2 offset)
         : this(data.Position + offset, data.Width, data.Height, data.Enum<MoveBlock.Directions>("direction"), data.Bool("fast") ? 75f : data.Float("moveSpeed", 60f))
     {
@@ -203,6 +205,8 @@ public ConnectedMoveBlock(EntityData data, Vector2 offset)
         crashTime = data.Float("crashTime", 0.15f);
         regenTime = data.Float("regenTime", 3f);
         shakeOnCollision = data.Bool("shakeOnCollision", true);
+
+        noDebris = data.Bool("noDebris");
     }
 
     public ConnectedMoveBlock(Vector2 position, int width, int height, MoveBlock.Directions direction, float moveSpeed)
@@ -370,20 +374,22 @@ protected virtual IEnumerator Controller()
             BreakParticles();
 
             List<MoveBlockDebris> debris = new();
-            int tWidth = (int) ((GroupBoundsMax.X - GroupBoundsMin.X) / 8);
-            int tHeight = (int) ((GroupBoundsMax.Y - GroupBoundsMin.Y) / 8);
+            if (!noDebris) {
+                int tWidth = (int) ((GroupBoundsMax.X - GroupBoundsMin.X) / 8);
+                int tHeight = (int) ((GroupBoundsMax.Y - GroupBoundsMin.Y) / 8);
 
-            for (int i = 0; i < tWidth; i++)
-            {
-                for (int j = 0; j < tHeight; j++)
+                for (int i = 0; i < tWidth; i++)
                 {
-                    if (AllGroupTiles[i, j])
+                    for (int j = 0; j < tHeight; j++)
                     {
-                        Vector2 value = new((i * 8) + 4, (j * 8) + 4);
-                        Vector2 pos = value + Position + GroupOffset;
-                        MoveBlockDebris debris2 = Engine.Pooler.Create<MoveBlockDebris>().Init(pos, GroupCenter, startPosition + GroupOffset + value);
-                        debris.Add(debris2);
-                        Scene.Add(debris2);
+                        if (AllGroupTiles[i, j])
+                        {
+                            Vector2 value = new((i * 8) + 4, (j * 8) + 4);
+                            Vector2 pos = value + Position + GroupOffset;
+                            MoveBlockDebris debris2 = Engine.Pooler.Create<MoveBlockDebris>().Init(pos, GroupCenter, startPosition + GroupOffset + value);
+                            debris.Add(debris2);
+                            Scene.Add(debris2);
+                        }
                     }
                 }
             }
@@ -443,7 +449,7 @@ protected virtual IEnumerator Controller()
             }
 
             Collidable = true;
-            EventInstance instance = Audio.Play(ReformBeginSoundEffect, debris[0].Position);
+            EventInstance instance = Audio.Play(ReformBeginSoundEffect, debris.FirstOrDefault()?.Position ?? Center);
             Coroutine component;
             Coroutine routine = component = new Coroutine(SoundFollowsDebrisCenter(instance, debris));
             Add(component);
@@ -483,7 +489,7 @@ protected virtual IEnumerator Controller()
 
     protected IEnumerator SoundFollowsDebrisCenter(EventInstance instance, List<MoveBlockDebris> debris)
     {
-        while (true)
+        while (true && debris.Count > 0)
         {
             instance.getPlaybackState(out PLAYBACK_STATE pLAYBACK_STATE);
             if (pLAYBACK_STATE == PLAYBACK_STATE.STOPPED)

src/Entities/ConnectedBlocks/EquationMoveBlock.cs

@@ -2,6 +2,7 @@
 using FMOD.Studio;
 using System.Collections;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace Celeste.Mod.CommunalHelper.Entities.ConnectedStuff;
 
@@ -188,20 +189,22 @@ MoveBlock.Directions.Up or
             BreakParticles();
 
             List<MoveBlockDebris> debris = new();
-            int tWidth = (int) ((GroupBoundsMax.X - GroupBoundsMin.X) / 8);
-            int tHeight = (int) ((GroupBoundsMax.Y - GroupBoundsMin.Y) / 8);
+            if (!noDebris) {
+                int tWidth = (int) ((GroupBoundsMax.X - GroupBoundsMin.X) / 8);
+                int tHeight = (int) ((GroupBoundsMax.Y - GroupBoundsMin.Y) / 8);
 
-            for (int i = 0; i < tWidth; i++)
-            {
-                for (int j = 0; j < tHeight; j++)
+                for (int i = 0; i < tWidth; i++)
                 {
-                    if (AllGroupTiles[i, j])
+                    for (int j = 0; j < tHeight; j++)
                     {
-                        Vector2 value = new((i * 8) + 4, (j * 8) + 4);
-                        Vector2 pos = value + Position + GroupOffset;
-                        MoveBlockDebris debris2 = Engine.Pooler.Create<MoveBlockDebris>().Init(pos, GroupCenter, startPosition + GroupOffset + value);
-                        debris.Add(debris2);
-                        Scene.Add(debris2);
+                        if (AllGroupTiles[i, j])
+                        {
+                            Vector2 value = new((i * 8) + 4, (j * 8) + 4);
+                            Vector2 pos = value + Position + GroupOffset;
+                            MoveBlockDebris debris2 = Engine.Pooler.Create<MoveBlockDebris>().Init(pos, GroupCenter, startPosition + GroupOffset + value);
+                            debris.Add(debris2);
+                            Scene.Add(debris2);
+                        }
                     }
                 }
             }
@@ -260,7 +263,7 @@ MoveBlock.Directions.Up or
             }
 
             Collidable = true;
-            EventInstance instance = Audio.Play(SFX.game_04_arrowblock_reform_begin, debris[0].Position);
+            EventInstance instance = Audio.Play(SFX.game_04_arrowblock_reform_begin, debris.FirstOrDefault()?.Position ?? Center);
             Coroutine component;
             Coroutine routine = component = new Coroutine(SoundFollowsDebrisCenter(instance, debris));
             Add(component);