Merge pull request CommunalHelper#254 from aonkeeper4/cassette-aero-blocks-v2

Add cassette functionality to Charged Aero Blocks

Author: catapillie

Loenn/entities/aero/aero_block_charged.lua

@@ -1,14 +1,24 @@
 local drawableNinePatch = require "structs.drawable_nine_patch"
 local drawableRectangle = require "structs.drawable_rectangle"
 local utils = require "utils"
+local communalHelper = require("mods").requireFromPlugin("libraries.communal_helper")
+
+local cassetteIndexOptions = {
+    ["None"] = -1,
+    ["0 - Blue"] = 0,
+    ["1 - Rose"] = 1,
+    ["2 - Bright Sun"] = 2,
+    ["3 - Malachite"] = 3
+}
+local cassetteIndexColors = communalHelper.cassetteBlockHexColors
 
 local aeroBlockCharged = {}
 
 aeroBlockCharged.name = "CommunalHelper/AeroBlockCharged"
 aeroBlockCharged.depth = 4999
-aeroBlockCharged.minimumSize = {16, 16}
+aeroBlockCharged.minimumSize = { 16, 16 }
 
-aeroBlockCharged.nodeLimits = {0, -1}
+aeroBlockCharged.nodeLimits = { 0, -1 }
 aeroBlockCharged.nodeLineRenderType = "line"
 
 aeroBlockCharged.fieldInformation = {
@@ -17,6 +27,14 @@ aeroBlockCharged.fieldInformation = {
     },
     inactiveColor = {
         fieldType = "color"
+    },
+    cassetteIndex = {
+        options = cassetteIndexOptions,
+        editable = false,
+        fieldType = "integer",
+    },
+    cassetteTempo = {
+        minimumValue = 0
     }
 }
 
@@ -31,16 +49,38 @@ aeroBlockCharged.placements = {
             loop = false,
             activeColor = "4BC0C8",
             inactiveColor = "FF6347",
-            easing = "CubeIn",
             -- SpirialisBug = false,
             SpirialisBugV2 = false,
-            wallbounceLeniency = true
+            wallbounceLeniency = true,
+            cassetteIndex = -1,
+            cassetteTempo = 1,
+            moveOnCassetteTick = false
         }
     }
 }
+for i = 0, 3 do
+    table.insert(aeroBlockCharged.placements, {
+        name = string.format("aero_block_charged_%s", i),
+        data = {
+            width = 16,
+            height = 16,
+            buttonSequence = "left -> right+top",
+            hover = true,
+            loop = false,
+            activeColor = cassetteIndexColors[i + 1],
+            inactiveColor = "FF6347",
+            -- SpirialisBug = false,
+            SpirialisBugV2 = false,
+            wallbounceLeniency = true,
+            cassetteIndex = i,
+            cassetteTempo = 1,
+            moveOnCassetteTick = false
+        }
+    })
+end
 
-local backgroundColor = {20 / 255, 3 / 255, 3 / 255}
-local outlineColor = {0, 0, 0}
+local backgroundColor = { 20 / 255, 3 / 255, 3 / 255 }
+local outlineColor = { 0, 0, 0 }
 local blockTexture = "objects/CommunalHelper/aero_block/blocks/nnn"
 
 local blockNinePatchOptions = {
@@ -60,6 +100,12 @@ function aeroBlockCharged.sprite(room, entity)
     table.insert(sprites, outline:getDrawableSprite())
     table.insert(sprites, rectangle:getDrawableSprite())
 
+    if entity.cassetteIndex and entity.cassetteIndex ~= -1 then
+        local cassetteIndicatorColor = entity.activeColor ~= "" and communalHelper.hexToColor(entity.activeColor) or cassetteIndexColors[entity.cassetteIndex + 1]
+        local cassetteIndicator = drawableRectangle.fromRectangle("fill", x + 4, y + 4, width - 8, height - 8, cassetteIndicatorColor)
+        table.insert(sprites, cassetteIndicator:getDrawableSprite())
+    end
+
     local frameNinePatch = drawableNinePatch.fromTexture(blockTexture, blockNinePatchOptions, x, y, width, height)
     local frameSprites = frameNinePatch:getDrawableSprite()
 
@@ -85,4 +131,4 @@ function aeroBlockCharged.selection(room, entity)
     return rect, noderects
 end
 
-return aeroBlockCharged
+return aeroBlockCharged

Loenn/lang/en_gb.lang

@@ -741,15 +741,22 @@ entities.CommunalHelper/AeroBlockFlying.attributes.description.endColor=The endi
 
 # Aero Block Charged
 entities.CommunalHelper/AeroBlockCharged.placements.name.aero_block_charged=Charged Aero Block
-entities.CommunalHelper/AeroBlockCharged.attributes.description.buttonSequence=Text that describes how the buttons of this block are shown and hidden as the block moves to each node. It is parsed by the entity, so this field must follow a specified format:\n\nFor each node, you can have the LEFT, RIGHT, and TOP buttons enabled or not.\nTo combine multiple buttons, use the + operator. For instance: LEFT+RIGHT represents both the left and right button enabled, while the top one is off.\n\nThere are other keywords that represent multiple buttons at once: HORIZONTAL, VERTICAL, ALL, NONE:\n  * HORIZONTAL = LEFT + RIGHT\n  * VERTICAL = TOP\n  * ALL = TOP + LEFT + RIGHT\n  * NONE: (no buttons)\n\nIf you have multiple nodes, you must use the -> operator (a hyphen followed by a right-chevron, aka. "greater than") to indicate that whatever follows is for the next node.\nFor instance: LEFT+RIGHT -> TOP will start the block with the left and right buttons on, and when the blocks moves at the next node, only the top button will be on.\nYou don't necessarily have to write as many -> transitions as nodes this entity has, because the button sequence will just loop back if it reaches its end before the block ends its node sequence.\nYou must not have more transitions than nodes. In such a case, the extra button combinations are discarded.\n\nEvery word can be lowercase (they are case-insensitive).\nOther words that are not LEFT, RIGHT, TOP, HORIZONTAL, VERTICAL, ALL, NONE, will be dismissed and a warning will be printed in the log.\nLeading & trailing whitespaces are discarded, so feel free to format the string the way you prefer.\n\nHere are more examples of valid sequences:\n  * LEFT\n  * HORIZONTAL -> TOP + LEFT\n  * right->left->tOP->All\n  * ALL -> none + LEFT+right -> rIgHt\n\nCheck the log if something goes wrong, you'll find the error messages there.
-entities.CommunalHelper/AeroBlockCharged.attributes.description.hover=Whether this block has a hovering "floating" movement to it. If disable, the block stays in place until it needs to move.
-entities.CommunalHelper/AeroBlockCharged.attributes.description.loop=Whether this block's sequence has no ending. When the last node is reached, it loops back around to the initial position.
-entities.CommunalHelper/AeroBlockCharged.attributes.description.activeColor=This block's button and screen particles color when it is active (flying). 
-entities.CommunalHelper/AeroBlockCharged.attributes.description.inactiveColor=This block's button colors when it is inactive.
-entities.CommunalHelper/AeroBlockCharged.attributes.description.SpirialisBug=This enables a bug where Spirialis Helper will override the player's jump speed with the boost from an Aero Block, even when Spirialis Helper is not enabled.\nThis effectively makes your vertical momentum much stronger than normal from aeroblocks in most, but not all, cases.\n(Legacy, replace this block for an improved version of this toggle.)
+entities.CommunalHelper/AeroBlockCharged.placements.name.aero_block_charged_0=Charged Aero Block (Cassette, 0 - Blue)
+entities.CommunalHelper/AeroBlockCharged.placements.name.aero_block_charged_1=Charged Aero Block (Cassette, 1 - Rose)
+entities.CommunalHelper/AeroBlockCharged.placements.name.aero_block_charged_2=Charged Aero Block (Cassette, 2 - Bright Sun)
+entities.CommunalHelper/AeroBlockCharged.placements.name.aero_block_charged_3=Charged Aero Block (Cassette, 3 - Malachite)
+entities.CommunalHelper/AeroBlockCharged.attributes.description.buttonSequence=Text that describes how the buttons of this block are shown and hidden as the block moves to each node. It is parsed by the entity, so this field must follow a specified format:\n\nFor each node, you can have the LEFT, RIGHT, and TOP buttons either enabled or not.\nTo combine multiple buttons, use a "+" symbol. For instance: LEFT+RIGHT represents both the left and right button being enabled, while the top one is not.\n\nThere are other keywords that represent multiple buttons at once: HORIZONTAL, VERTICAL, ALL, NONE:\n  * HORIZONTAL = LEFT + RIGHT\n  * VERTICAL = TOP\n  * ALL = TOP + LEFT + RIGHT\n  * NONE: (no buttons)\n\nIf you have multiple nodes, you must list the buttons for each node, separated by "->".\nFor instance: LEFT+RIGHT -> TOP will start the block with the left and right buttons on, and when the blocks moves to the next node, only the top button will be on.\nYou don't necessarily have to write as many button combinations as the number of nodes this entity has, because the button sequence will loop if it is exhausted before the block reaches the end of its node sequence.\nHowever, you should not have more button combinations than nodes as the extra button combinations will be discarded.\n\nWord capitalization does not matter.\nWords that are not LEFT, RIGHT, TOP, HORIZONTAL, VERTICAL, ALL or NONE will be dismissed and a warning will be printed in the log.\nLeading & trailing whitespaces are discarded, so feel free to format the string the way you prefer.\n\nHere are more examples of valid sequences:\n  * LEFT\n  * HORIZONTAL -> TOP + LEFT\n  * right->left->tOP->All\n  * ALL -> none + LEFT+right -> rIgHt\n\nIf something goes wrong, check the log; you'll find the error messages there.
+entities.CommunalHelper/AeroBlockCharged.attributes.description.hover=Whether this block has a "floating" movement when idle. If disabled, the block stays in place until it needs to move.
+entities.CommunalHelper/AeroBlockCharged.attributes.description.loop=Whether when the last node of this block's sequence is reached, it should loop back around to the initial position instead of becoming inactive.
+entities.CommunalHelper/AeroBlockCharged.attributes.description.activeColor=This block's button and screen particle color when it is active. 
+entities.CommunalHelper/AeroBlockCharged.attributes.description.inactiveColor=This block's button color when it is inactive.
+entities.CommunalHelper/AeroBlockCharged.attributes.description.SpirialisBug=This enables a bug where Spirialis Helper will override the player's jump speed with the boost from an Aero Block, even when Spirialis Helper is not enabled.\nThis effectively makes your vertical momentum much stronger than normal from Aero Blocks in most, but not all, cases.\n(Legacy, replace this block for an improved version of this toggle.)
 entities.CommunalHelper/AeroBlockCharged.attributes.name.SpirialisBugV2=Stronger Vertical Boost
 entities.CommunalHelper/AeroBlockCharged.attributes.description.SpirialisBugV2=This enables a legacy behavior (originally caused by Spirialis Helper) where the player's jump speed will be overridden with the boost from an Aero Block.\nTurning this on effectively makes your vertical momentum from Aero Blocks much stronger than normal in most cases.
-entities.CommunalHelper/AeroBlockCharged.attributes.description.wallbounceLeniency=Allows wallbounces up to all 5 pixels of horizontal leniency to receive the boost from this block instead of only ones within the first 3 pixels.\nThis prevents there from being a 2 pixel window where you can wallbounce without receiving the boost.
+entities.CommunalHelper/AeroBlockCharged.attributes.description.wallbounceLeniency=Allows wallbounces up to all 5 pixels of horizontal leniency to receive the boost from this block instead of only the first 3 pixels.\nThis prevents there from being a 2 pixel window where you can wallbounce without receiving the boost.
+entities.CommunalHelper/AeroBlockCharged.attributes.description.cassetteIndex=The cassette index of this Charged Aero Block. If set to anything other than "None", the buttons on this block will (de)activate in sync with cassette blocks of this index.
+entities.CommunalHelper/AeroBlockCharged.attributes.description.cassetteTempo=The cassette tempo of this Charged Aero Block. See the tooltip of the "Tempo" field on Cassette Blocks for a thorough explanation.\nDoes nothing if "Cassette Index" is set to "None".
+entities.CommunalHelper/AeroBlockCharged.attributes.description.moveOnCassetteTick=Whether this block will move to the next node at the end of the current cassette tick if it has not already been activated.\nDoes nothing if "Cassette Index" is set to "None".
 
 # Aero Block Slingshot
 entities.CommunalHelper/AeroBlockSlingshot.placements.name.normal=Slingshot Aero Block