Components

.Tilemaps. Components

Methods

(static) CalculateFacesAt(tileX, tileY, layer)

Since:
  • 3.0.0
在指定图层的给定图块坐标处计算感兴趣的面.有趣的 面在内部用于优化与瓷砖的碰撞.这种方法是最常用的 内部优化重新计算面时,只有一个瓷砖已经改变.
Parameters:
Name Type Description
tileX number x坐标.
tileY number y坐标.
layer Phaser.Tilemaps.LayerData 要操作的平铺层.

(static) CalculateFacesWithin(tileX, tileY, width, height, layer)

Since:
  • 3.0.0
计算矩形区域内的感兴趣的面 层.有趣的面在内部用于优化与瓷砖的碰撞.这个方法 主要用于内部.
Parameters:
Name Type Description
tileX number 用作区域原点的最左边的图块索引(在图块坐标中).
tileY number 用作区域原点的最上面的图块索引(在图块坐标中).
width number 该区域距离 `tileX` 索引有多宽.
height number 从 `tileY` 索引开始,该区域将有多少个瓷砖高.
layer Phaser.Tilemaps.LayerData 要操作的平铺层.

(static) CheckIsoBounds(tileX, tileY, layer, cameraopt) → {boolean}

Since:
  • 3.50.0
检查给定的图块坐标是否在等轴测图层边界内.
Parameters:
Name Type Attributes Description
tileX number x坐标,以图块为单位,而不是像素.
tileY number y坐标,以平铺显示,而不是像素.
layer Phaser.Tilemaps.LayerData 要检查的波浪图层.
camera Phaser.Cameras.Scene2D.Camera <optional>
运行剔除检查的摄像机.
Returns:
如果坐标在iso范围内,则返回 `true` .
Type
boolean

(static) Copy(srcTileX, srcTileY, width, height, destTileX, destTileY, recalculateFaces, layer)

Since:
  • 3.0.0
将源矩形区域中的切片复制到新的目标(都在切片中指定 坐标).这会复制所有图块属性并重新计算碰撞 目标区域中的信息.
Parameters:
Name Type Description
srcTileX number 要复制的区域的x坐标,以图块为单位,而不是像素.
srcTileY number 要复制的区域的y坐标,以图块为单位,而不是像素.
width number 要复制的区域的宽度,以平铺显示,而不是以像素显示.
height number 要复制的区域的高度,以平铺显示,而不是像素.
destTileX number 要复制到的区域的x坐标,单位为切片,而不是像素.
destTileY number 要复制到的区域的y坐标,单位为切片,而不是像素.
recalculateFaces boolean `true` 如果应该重新计算人脸数据.
layer Phaser.Tilemaps.LayerData 要操作的平铺层.

(static) CreateFromTiles(indexes, replacements, spriteConfig, scene, camera, layer) → {Array.<Phaser.GameObjects.Sprite>}

Since:
  • 3.0.0
为层中匹配给定平铺索引的每个对象创建一个子画面.你可以 (可选)指定在精灵被替换后,是否用新的图块替换每个图块 创建.如果您想要在转换为的级别中放置特殊的平铺,这很有用 精灵,但是想要在转换后用地砖或类似的东西替换瓷砖本身.
Parameters:
Name Type Description
indexes number | Array.<number> 要从中创建子画面的平铺索引或索引数组.
replacements number | Array.<number> 要将转换后的切片更改为的切片索引或索引数组.设置为 `null` 以保持图块不变.如果给定了一个数组,则假定它与索引数组是一对一的映射.
spriteConfig Phaser.Types.GameObjects.Sprite.SpriteConfig 要传递给精灵创建者的配置对象(即.场景. make.sprite).
scene Phaser.Scene 要在其中创建精灵的场景.
camera Phaser.Cameras.Scene2D.Camera 确定世界XY时使用的摄像机
layer Phaser.Tilemaps.LayerData 要操作的平铺层.
Returns:
创建的精灵数组.
Type
Array.<Phaser.GameObjects.Sprite>

(static) CullBounds(layer, camera) → {Phaser.Geom.Rectangle}

Since:
  • 3.50.0
返回相机视口内给定正交图层的边界. 这由剔除平铺功能在内部使用.
Parameters:
Name Type Description
layer Phaser.Tilemaps.LayerData 要操作的平铺层.
camera Phaser.Cameras.Scene2D.Camera 运行剔除检查的摄像机.
Returns:
包含剔除边界的矩形.如果您希望保留此对象,请克隆它,因为它是内部回收的.
Type
Phaser.Geom.Rectangle

(static) CullTiles(layer, camera, outputArrayopt, renderOrderopt) → {Array.<Phaser.Tilemaps.Tile>}

Since:
  • 3.50.0
返回相机视口内给定图层中的切片.这是内部使用的.
Parameters:
Name Type Attributes Default Description
layer Phaser.Tilemaps.LayerData 要操作的平铺层.
camera Phaser.Cameras.Scene2D.Camera 运行剔除检查的摄像机.
outputArray array <optional>
存储平铺对象的可选数组.
renderOrder number <optional>
0 渲染顺序常数.
Returns:
平铺对象的数组.
Type
Array.<Phaser.Tilemaps.Tile>

(static) Fill(index, tileX, tileY, width, height, recalculateFaces, layer)

Since:
  • 3.0.0
属性在层的给定矩形区域(以切片坐标表示)中设置切片 指定的索引.如果给定的索引是冲突索引,切片将被设置为冲突. 将重新计算该区域的碰撞信息.
Parameters:
Name Type Description
index number 要填充区域的切片索引.
tileX number 用作区域原点的最左边的图块索引(在图块坐标中).
tileY number 用作区域原点的最上面的图块索引(在图块坐标中).
width number 该区域距离 `tileX` 索引有多宽.
height number 从 `tileY` 索引开始,该区域将有多少个瓷砖高.
recalculateFaces boolean `true` 如果应该重新计算人脸数据.
layer Phaser.Tilemaps.LayerData 要使用的平铺层.如果没有给定,则使用当前层.

(static) FilterTiles(callback, context, tileX, tileY, width, height, filteringOptions, layer) → {Array.<Phaser.Tilemaps.Tile>}

Since:
  • 3.0.0
对于层的给定矩形区域(以图块坐标表示)中的每个图块,运行给定的 过滤器回调函数.通过过滤测试的任何瓷砖(即.回调返回的地方 true)将作为新数组返回.类似于普通JS中的Array.prototype.Filter.
Parameters:
Name Type Description
callback function 回调.给定区域中的每个图块都将被传递到此 回调作为第一个也是唯一的参数.对于传递 过滤器.
context object 应该在其中运行回调的上下文.
tileX number 最左边的图块索引(以图块坐标表示),用作要过滤的区域的原点.
tileY number 用作要过滤的区域的原点的最上面的图块索引(以图块坐标表示).
width number 该区域距离 `tileX` 索引有多宽.
height number 从 `tileY` 索引开始,该区域将有多少个瓷砖高.
filteringOptions Phaser.Types.Tilemaps.FilteringOptions 获取切片时要应用的可选过滤器.
layer Phaser.Tilemaps.LayerData 要操作的平铺层.
Returns:
经过筛选的切片数组.
Type
Array.<Phaser.Tilemaps.Tile>

(static) FindByIndex(index, skip, reverse, layer) → (nullable) {Phaser.Tilemaps.Tile}

Since:
  • 3.0.0
在整个地图图层中搜索与给定索引匹配的第一个切片,然后返回该切片 对象.如果没有找到匹配项,则返回null.搜索从左上角的图块开始 水平继续,直到到达行尾,然后下降到下一列. 如果反向布尔值为真,它将从右下角开始扫描,一直扫描到 左上角.
Parameters:
Name Type Description
index number 要搜索的切片索引值.
skip number 返回前跳过匹配切片的次数.
reverse boolean 如果为真,它将从右下角开始反向扫描图层.否则,它从左上角开始扫描.
layer Phaser.Tilemaps.LayerData 要操作的平铺层.
Returns:
具有匹配索引的第一个(或n个跳过的)切片.
Type
Phaser.Tilemaps.Tile

(static) FindTile(callback, context, tileX, tileY, width, height, filteringOptions, layer) → (nullable) {Phaser.Tilemaps.Tile}

Since:
  • 3.0.0
在层的给定矩形区域(在图块坐标中)找到第一个图块,该图块 满足所提供的测试功能.即.查找 `callback` 返回的第一个图块 没错.类似于Array.prototype.find中的香草JS.
Parameters:
Name Type Description
callback FindTileCallback 回调.给定区域中的每个图块都将作为第一个也是唯一一个参数传递给该回调.
context object 应该在其中运行回调的上下文.
tileX number 最左边的图块索引(以图块坐标表示),用作要过滤的区域的原点.
tileY number 用作要过滤的区域的原点的最上面的图块索引(以图块坐标表示).
width number 该区域距离 `tileX` 索引有多宽.
height number 从 `tileY` 索引开始,该区域将有多少个瓷砖高.
filteringOptions Phaser.Types.Tilemaps.FilteringOptions 获取切片时要应用的可选过滤器.
layer Phaser.Tilemaps.LayerData 要操作的平铺层.
Returns:
匹配搜索的切片,如果未找到切片,则为空
Type
Phaser.Tilemaps.Tile

(static) ForEachTile(callback, context, tileX, tileY, width, height, filteringOptions, layer)

Since:
  • 3.0.0
对于层的给定矩形区域(以图块坐标表示)中的每个图块,运行给定的 回调.类似于普通JS中的Array.prototype.forEach.
Parameters:
Name Type Description
callback EachTileCallback 回调.给定区域中的每个图块都将作为第一个也是唯一一个参数传递给该回调.
context object 应该在其中运行回调的上下文.
tileX number 最左边的图块索引(以图块坐标表示),用作要过滤的区域的原点.
tileY number 用作要过滤的区域的原点的最上面的图块索引(以图块坐标表示).
width number 该区域距离 `tileX` 索引有多宽.
height number 从 `tileY` 索引开始,该区域将有多少个瓷砖高.
filteringOptions Phaser.Types.Tilemaps.FilteringOptions 获取切片时要应用的可选过滤器.
layer Phaser.Tilemaps.LayerData 要操作的平铺层.

(static) GetCullTilesFunction(orientation) → {function}

Since:
  • 3.50.0
根据地图方向获取用于剔除切片的正确函数.
Parameters:
Name Type Description
orientation number Tilemap方向常数.
Returns:
用于为给定地图类型挑选图块的函数.
Type
function

(static) GetTileAt(tileX, tileY, nonNull, layer) → {Phaser.Tilemaps.Tile}

Since:
  • 3.0.0
从给定层获取给定切片坐标处的切片.
Parameters:
Name Type Description
tileX number 获取图块的x位置(以图块单位给出,而不是像素).
tileY number 获取图块的y位置(以图块单位给出,而不是像素).
nonNull boolean 如果为真,getTile不会为空切片返回空值,而是为索引为-1的切片对象.
layer Phaser.Tilemaps.LayerData 要操作的平铺层.
Returns:
给定坐标处的图块,如果未找到图块或坐标无效,则为空.
Type
Phaser.Tilemaps.Tile