add reskin support to boom boxes and boom box zips

Author: earthwise01

Code/Entities/BoomBox.cs

@@ -36,7 +36,7 @@ public class BoomBox : Solid {
         private Coroutine _sequence;
         private bool _steamAnger = false;
 
-        public BoomBox(Vector2 position, string activationId, float initialDelay, bool startActive)
+        public BoomBox(Vector2 position, string activationId, float initialDelay, bool startActive, string spriteDir)
             : base(position, 24, 24, false) {
             Add(Activator = new FactoryActivator());
             Activator.StartOn = startActive;
@@ -50,14 +50,16 @@ public BoomBox(Vector2 position, string activationId, float initialDelay, bool s
 
             _initialDelay = initialDelay;
 
-            Add(_sprite = new Sprite(GFX.Game, "objects/FactoryHelper/boomBox/"));
+            string spritePath = string.IsNullOrEmpty(spriteDir) ? "objects/FactoryHelper/boomBox/" : spriteDir + "/";
+
+            Add(_sprite = new Sprite(GFX.Game, spritePath));
             _sprite.Add("idle", "idle", 0.2f, "idle");
             _sprite.Add("activating", "activating", 0.2f, "activating");
             _sprite.Add("active", "active", 0.15f, "active");
             _sprite.Add("angry", "angry", 0.05f, "angry");
             _sprite.Add("resetting", "resetting", 0.15f, "active");
 
-            Add(_boomSprite = new Sprite(GFX.Game, "objects/FactoryHelper/boomBox/"));
+            Add(_boomSprite = new Sprite(GFX.Game, spritePath));
             _boomSprite.Add("boom", "boom", 0.04f);
             _boomSprite.Color = Color.White * 0.5f;
             _boomSprite.Visible = false;
@@ -71,7 +73,7 @@ public BoomBox(Vector2 position, string activationId, float initialDelay, bool s
         }
 
         public BoomBox(EntityData data, Vector2 offest)
-            : this(data.Position + offest, data.Attr("activationId", ""), data.Float("initialDelay", 0f), data.Bool("startActive", false)) {
+            : this(data.Position + offest, data.Attr("activationId", ""), data.Float("initialDelay", 0f), data.Bool("startActive", false), data.Attr("spriteDir", "")) {
         }
 
         public FactoryActivator Activator { get; }

Code/Entities/BoomBoxZip.cs

@@ -13,11 +13,11 @@ public class BoomBoxZip : BoomBox {
         private ZipMoverPathRenderer pathRenderer;
 
         public BoomBoxZip(EntityData data, Vector2 offset) 
-            : this(data.Position + offset, data.Attr("activationId", ""), data.Float("initialDelay", 0f), data.Bool("startActive", false), data.Nodes[0] + offset) {
+            : this(data.Position + offset, data.Attr("activationId", ""), data.Float("initialDelay", 0f), data.Bool("startActive", false), data.Attr("spriteDir", ""), data.Nodes[0] + offset) {
         }
 
-        public BoomBoxZip(Vector2 position, string activationId, float initialDelay, bool startActive, Vector2 target) 
-            : base(position, activationId, initialDelay, startActive) {
+        public BoomBoxZip(Vector2 position, string activationId, float initialDelay, bool startActive, string spriteDir, Vector2 target) 
+            : base(position, activationId, initialDelay, startActive, spriteDir) {
             Add(new Coroutine(ZipMoverSequence()));
             this.start = this.Position;
             this.target = target;

Loenn/entities/boom_box.lua

@@ -13,15 +13,14 @@ boomBox.placements = {
     data = {
         activationId = "",
         initialDelay = 0.0,
-        startActive = true
+        startActive = true,
+        spriteDir = ""
     }
 }
 
-local inactiveTexture = "objects/FactoryHelper/boomBox/idle00"
-local activeTexture = "objects/FactoryHelper/boomBox/active00"
-
 function boomBox.texture(room, entity)
-    return entity.startActive and activeTexture or inactiveTexture
+    local spriteDir = (entity.spriteDir or "") == "" and "objects/FactoryHelper/boomBox" or entity.spriteDir
+    return spriteDir .. (entity.startActive and "/active00" or "/idle00")
 end
 
 boomBox.justification = {0.0, 0.0}

Loenn/entities/boom_box_zip.lua

@@ -24,12 +24,11 @@ boomBoxZip.placements = {
         width = 24,
         activationId = "",
         initialDelay = 0.0,
-        startActive = true
+        startActive = true,
+        spriteDir = ""
     }
 }
 
-local inactiveTexture = "objects/FactoryHelper/boomBox/idle00"
-local activeTexture = "objects/FactoryHelper/boomBox/active00"
 local cogTexture = "objects/zipmover/cog"
 local ropeColor = {77 / 255, 60 / 255, 34 / 255}
 
@@ -61,10 +60,10 @@ end
 
 function boomBoxZip.sprite(room, entity)
     local sprites = {}
-    
+
     local x, y = entity.x or 0, entity.y or 0
     local nodes = entity.nodes or {{x = 0, y = 0}}
-    
+
     -- Draw cog + rope
     local halfWidth = 12
     local centerX = x + halfWidth
@@ -74,19 +73,20 @@ function boomBoxZip.sprite(room, entity)
     addNodeSprites(sprites, entity, centerX, centerY, centerNodeX, centerNodeY)
 
     -- Draw boom box
-    local boomBoxTex = entity.startActive and activeTexture or inactiveTexture
+    local spriteDir = (entity.spriteDir or "") == "" and "objects/FactoryHelper/boomBox" or entity.spriteDir
+    local boomBoxTex = spriteDir .. (entity.startActive and "/active00" or "/idle00")
     local boomBoxSprite = drawableSprite.fromTexture(boomBoxTex, entity)
     boomBoxSprite:setPosition(centerX, centerY)
     boomBoxSprite:setJustification(0.5, 0.5)
     table.insert(sprites, boomBoxSprite)
-    
+
     return sprites
 end
 
 function boomBoxZip.selection(room, entity)
     local x, y = entity.x or 0, entity.y or 0
     local nodes = entity.nodes or {{x = 0, y = 0}}
-    
+
     local halfWidth = 12
     local centerX = x + halfWidth
     local centerY = y + halfWidth

Loenn/lang/en_gb.lang

@@ -13,12 +13,14 @@ entities.FactoryHelper/BoomBox.placements.name.active=Boom Box
 entities.FactoryHelper/BoomBox.attributes.description.activationId=String value of the entity's activator ID. When a factory activator with this ID is turned on, the entity will toggle state.
 entities.FactoryHelper/BoomBox.attributes.description.initialDelay=The time it takes before the box starts turning on in seconds after activated.
 entities.FactoryHelper/BoomBox.attributes.description.startActive=If `true` the boom box will initially be active.
+entities.FactoryHelper/BoomBox.attributes.description.spriteDir=The directory to look in for boom box sprites, relative to "Graphics/Atlases/Gameplay/".\nThe directory must contain "idle", "activating", "active", "angry", and "resetting" animations for the block, and a "boom" animation for the explosion.\nIf left empty, the default sprites in "objects/FactoryHelper/boomBox" will be used.
 
 # Boom Box Zip
 entities.FactoryHelper/BoomBoxZip.placements.name.active=Boom Box Zip
 entities.FactoryHelper/BoomBoxZip.attributes.description.activationId=String value of the entity's activator ID. When a factory activator with this ID is turned on, the entity will toggle state.
 entities.FactoryHelper/BoomBoxZip.attributes.description.initialDelay=The time it takes before the box starts turning on in seconds after activated.
 entities.FactoryHelper/BoomBoxZip.attributes.description.startActive=If `true` the boom box will initially be active.
+entities.FactoryHelper/BoomBoxZip.attributes.description.spriteDir=The directory to look in for boom box sprites, relative to "Graphics/Atlases/Gameplay/".\nThe directory must contain "idle", "activating", "active", "angry", and "resetting" animations for the block, and a "boom" animation for the explosion.\nIf left empty, the default sprites in "objects/FactoryHelper/boomBox" will be used.
 
 # Conveyor
 entities.FactoryHelper/Conveyor.placements.name.start_left=Conveyor (Left)