Tilemaps.Components.StaggeredWorldToTileY is a new function that converts world Y coordinates from pixels to staggered tile Y coordinates.

Author: photonstorm

src/tilemaps/components/StaggeredWorldToTileY.js

@@ -0,0 +1,45 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * Converts from world Y coordinates (pixels) to staggered tile Y coordinates (tile units), factoring in the
+ * layers position, scale and scroll.
+ *
+ * @function Phaser.Tilemaps.Components.StaggeredWorldToTileY
+ * @since 3.50.0
+ *
+ * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.
+ * @param {boolean} [snapToFloor=true] - Whether or not to round the tile coordinate down to the nearest integer.
+ * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
+ * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
+ *
+ * @return {number} The Y location in tile units.
+ */
+var StaggeredWorldToTileY = function (worldY, snapToFloor, camera, layer)
+{
+    if (snapToFloor === undefined) { snapToFloor = true; }
+
+    var tileHeight = layer.baseTileHeight;
+    var tilemapLayer = layer.tilemapLayer;
+
+    if (tilemapLayer)
+    {
+        if (camera === undefined) { camera = tilemapLayer.scene.cameras.main; }
+
+        //  Find the world position relative to the static or dynamic layer's top left origin,
+        //  factoring in the camera's vertical scroll
+
+        worldY = worldY - (tilemapLayer.y + camera.scrollY * (1 - tilemapLayer.scrollFactorY));
+
+        tileHeight *= tilemapLayer.scaleY;
+    }
+
+    return snapToFloor
+        ? Math.floor(worldY / (tileHeight / 2))
+        : worldY / (tileHeight / 2);
+};
+
+module.exports = StaggeredWorldToTileY;