Extra tilemap method findTile (matches Array.prototype.find)

Author: mikewesthad

v3/src/gameobjects/tilemap/Tilemap.js

@@ -589,6 +589,18 @@ var Tilemap = new Class({
         return TilemapComponents.FindByIndex(findIndex, skip, reverse, layer);
     },
 
+    /**
+     * See component documentation. If no layer specified, the map's current layer is used.
+     *
+     * @return {Tile|null} Returns a Tiles, or null if the layer given was invalid.
+     */
+    findTile: function (callback, context, tileX, tileY, width, height, filteringOptions, layer)
+    {
+        layer = this.getLayer(layer);
+        if (layer === null) { return null; }
+        return TilemapComponents.FindTile(callback, context, tileX, tileY, width, height, filteringOptions, layer);
+    },
+
     /**
      * See component documentation. If no layer specified, the map's current layer is used.
      *

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

@@ -0,0 +1,31 @@
+var GetTilesWithin = require('./GetTilesWithin');
+
+/**
+ * Find the first tile in the given rectangular area (in tile coordinates) of the layer that
+ * satisfies the provided testing function. I.e. finds the first tile for which `callback` returns
+ * true. Similar to Array.prototype.find in vanilla JS.
+ *
+ * @param {function} callback - The callback. Each tile in the given area will be passed to this
+ * callback as the first and only parameter.
+ * @param {object} [context] - The context under which the callback should be run.
+ * @param {integer} [tileX=0] - [description]
+ * @param {integer} [tileY=0] - [description]
+ * @param {integer} [width=max width based on tileX] - [description]
+ * @param {integer} [height=max height based on tileY] - [description]
+ * @param {object} [filteringOptions] - Optional filters to apply when getting the tiles.
+ * @param {boolean} [filteringOptions.isNotEmpty=false] - If true, only return tiles that don't have
+ * -1 for an index.
+ * @param {boolean} [filteringOptions.isColliding=false] - If true, only return tiles that collide
+ * on at least one side.
+ * @param {boolean} [filteringOptions.hasInterestingFace=false] - If true, only return tiles that
+ * have at least one interesting face.
+ * @param {LayerData} layer - [description]
+ * @return {Tile|null} A Tile that matches the search, or null if no Tile found
+ */
+var FindTile = function (callback, context, tileX, tileY, width, height, filteringOptions, layer)
+{
+    var tiles = GetTilesWithin(tileX, tileY, width, height, filteringOptions, layer);
+    return tiles.find(callback, context) || null;
+};
+
+module.exports = FindTile;

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

@@ -5,6 +5,7 @@ module.exports = {
     CullTiles: require('./CullTiles'),
     Fill: require('./Fill'),
     FindByIndex: require('./FindByIndex'),
+    FindTile: require('./FindTile'),
     FilterTiles: require('./FilterTiles'),
     ForEachTile: require('./ForEachTile'),
     GetTileAt: require('./GetTileAt'),

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

@@ -181,6 +181,16 @@ var DynamicTilemapLayer = new Class({
         return TilemapComponents.FindByIndex(findIndex, skip, reverse, this.layer);
     },
 
+    /**
+     * See component documentation.
+     *
+     * @return {Tile|null}
+     */
+    findTile: function (callback, context, tileX, tileY, width, height, filteringOptions)
+    {
+        return TilemapComponents.FindTile(callback, context, tileX, tileY, width, height, filteringOptions, this.layer);
+    },
+
     /**
      * See component documentation.
      *

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

@@ -310,6 +310,16 @@ var StaticTilemapLayer = new Class({
         return TilemapComponents.FindByIndex(findIndex, skip, reverse, this.layer);
     },
 
+    /**
+     * See component documentation.
+     *
+     * @return {Tile|null}
+     */
+    findTile: function (callback, context, tileX, tileY, width, height, filteringOptions)
+    {
+        return TilemapComponents.FindTile(callback, context, tileX, tileY, width, height, filteringOptions, this.layer);
+    },
+
     /**
      * See component documentation.
      *