World to Tile conversion on maps and layers - both accounting for camera scroll

Author: mikewesthad

v3/src/gameobjects/tilemap/Tilemap.js

@@ -333,6 +333,7 @@ var Tilemap = new Class({
     putTile: function (tile, tileX, tileY, layer)
     {
         layer = this.getLayer(layer);
+        if (this._isStaticCall(layer, 'putTile')) { return null; }
         if (layer === null) { return null; }
         return TilemapComponents.PutTile(tile, tileX, tileY, layer);
     },
@@ -414,6 +415,27 @@ var Tilemap = new Class({
         return this;
     },
 
+    worldToTileX: function (worldX, camera, layer)
+    {
+        layer = this.getLayer(layer);
+        if (layer === null) { return null; }
+        return TilemapComponents.WorldToTileX(worldX, camera, layer);
+    },
+
+    worldToTileY: function (worldY, camera, layer)
+    {
+        layer = this.getLayer(layer);
+        if (layer === null) { return null; }
+        return TilemapComponents.WorldToTileY(worldY, camera, layer);
+    },
+
+    worldToTileXY: function (worldX, worldY, point, camera, layer)
+    {
+        layer = this.getLayer(layer);
+        if (layer === null) { return null; }
+        return TilemapComponents.WorldToTileXY(worldX, worldY, point, camera, layer);
+    },
+
     _isStaticCall: function (layer, functionName)
     {
         if (layer.tilemapLayer instanceof StaticTilemapLayer)

v3/src/gameobjects/tilemap/components/WorldToTileX.js

@@ -0,0 +1,18 @@
+var SnapFloor = require('../../../math/snap/SnapFloor');
+
+var WorldToTileX = function (worldX, camera, layer)
+{
+    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 horizontal scroll
+        worldX = worldX + (camera.scrollX * tilemapLayer.scrollFactorX) - tilemapLayer.x;
+    }
+
+    return SnapFloor(worldX, layer.tileWidth) / layer.tileWidth;
+};
+
+module.exports = WorldToTileX;

v3/src/gameobjects/tilemap/components/WorldToTileXY.js

@@ -0,0 +1,15 @@
+var WorldToTileX = require('./WorldToTileX');
+var WorldToTileY = require('./WorldToTileY');
+var Vector2 = require('../../../math/Vector2');
+
+var WorldToTileXY = function (worldX, worldY, point, camera, layer)
+{
+    if (point === undefined) { point = new Vector2(0, 0); }
+
+    point.x = WorldToTileX(worldX, camera, layer);
+    point.y = WorldToTileY(worldY, camera, layer);
+
+    return point;
+};
+
+module.exports = WorldToTileXY;

v3/src/gameobjects/tilemap/components/WorldToTileY.js

@@ -0,0 +1,18 @@
+var SnapFloor = require('../../../math/snap/SnapFloor');
+
+var WorldToTileY = function (worldY, camera, layer)
+{
+    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 horizontal scroll
+        worldY = worldY + (camera.scrollY * tilemapLayer.scrollFactorY) - tilemapLayer.y;
+    }
+
+    return SnapFloor(worldY, layer.tileWidth) / layer.tileWidth;
+};
+
+module.exports = WorldToTileY;

v3/src/gameobjects/tilemap/components/index.js

@@ -14,6 +14,9 @@ module.exports = {
     RemoveTile: require('./RemoveTile'),
     ReplaceByIndex: require('./ReplaceByIndex'),
     Shuffle: require('./Shuffle'),
-    SwapByIndex: require('./SwapByIndex')
+    SwapByIndex: require('./SwapByIndex'),
+    WorldToTileX: require('./WorldToTileX'),
+    WorldToTileXY: require('./WorldToTileXY'),
+    WorldToTileY: require('./WorldToTileY')
 
 };

v3/src/gameobjects/tilemap/dynamiclayer/DynamicTilemapLayer.js

@@ -184,6 +184,21 @@ var DynamicTilemapLayer = new Class({
     {
         TilemapComponents.SwapByIndex(indexA, indexB, tileX, tileY, width, height, this.layer);
         return this;
+    },
+
+    worldToTileX: function (worldX, camera)
+    {
+        return TilemapComponents.WorldToTileX(worldX, camera, this.layer);
+    },
+
+    worldToTileY: function (worldY, camera)
+    {
+        return TilemapComponents.WorldToTileY(worldY, camera, this.layer);
+    },
+
+    worldToTileXY: function (worldX, worldY, point, camera)
+    {
+        return TilemapComponents.WorldToTileXY(worldX, worldY, point, camera, this.layer);
     }
 
 });

v3/src/gameobjects/tilemap/staticlayer/StaticTilemapLayer.js

@@ -311,6 +311,21 @@ var StaticTilemapLayer = new Class({
     hasTileAt: function (tileX, tileY)
     {
         return TilemapComponents.HasTileAt(tileX, tileY, this.layer);
+    },
+
+    worldToTileX: function (worldX, camera)
+    {
+        return TilemapComponents.WorldToTileX(worldX, camera, this.layer);
+    },
+
+    worldToTileY: function (worldY, camera)
+    {
+        return TilemapComponents.WorldToTileY(worldY, camera, this.layer);
+    },
+
+    worldToTileXY: function (worldX, worldY, point, camera)
+    {
+        return TilemapComponents.WorldToTileXY(worldX, worldY, point, camera, this.layer);
     }
 
 });