ImageCollection

.Tilemaps. ImageCollection

图像集合是一个包含多个图像的特殊切片集,每个图像都没有切片. 图像集合通常在加载切片数据时自动创建.

Constructor

new ImageCollection(name, firstgid, widthopt, heightopt, marginopt, spacingopt, propertiesopt)

Since:
  • 3.0.0
Parameters:
Name Type Attributes Default Description
name string 地图数据中图像集合的名称.
firstgid number 此图像集合包含的第一个图像索引.
width number <optional>
32 最宽图像的宽度(像素).
height number <optional>
32 最高图像的高度(像素).
margin number <optional>
0 集合中所有图像的边距(以像素为单位).
spacing number <optional>
0 集合中每个图像之间的间距(以像素为单位).
properties object <optional>
{} 自定义图像集合属性.

Members

firstgid :number

Since:
  • 3.0.0
平铺的第一个gid值. 这是此图像集合包含的第一个图像索引的起始索引.
Type:
  • number

(readonly) imageHeight :number

Since:
  • 3.0.0
最高图像的高度(以像素为单位).
Type:
  • number

(readonly) imageMarge :number

Since:
  • 3.0.0
集合中图像周围的边距(像素). 使用 `setSpacing` 进行更改.
Type:
  • number

(readonly) images :array

Since:
  • 3.0.0
作为此集合一部分的缓存图像.
Type:
  • array

(readonly) imageSpacing :number

Since:
  • 3.0.0
集合中每个图像之间的间距(以像素为单位). 使用 `setSpacing` 进行更改.
Type:
  • number

(readonly) imageWidth :number

Since:
  • 3.0.0
最宽图像的宽度(以像素为单位).
Type:
  • number

name :string

Since:
  • 3.0.0
图像集合的名称.
Type:
  • string

properties :object

Since:
  • 3.0.0
图像集合特定的属性,通常在平铺编辑器中定义.
Type:
  • object

(readonly) total :number

Since:
  • 3.0.0
图像集合中的图像总数.
Type:
  • number

Methods

addImage(gid, image) → {Phaser.Tilemaps.ImageCollection}

Since:
  • 3.0.0
向此图像集合添加图像.
Parameters:
Name Type Description
gid number 图像集合中图像的gid.
image string 图像集合和缓存中图像的键.
Returns:
此ImageCollection对象.
Type
Phaser.Tilemaps.ImageCollection

containsImageIndex(imageIndex) → {boolean}

Since:
  • 3.0.0
当且仅当此图像集合包含给定的图像索引时,返回true.
Parameters:
Name Type Description
imageIndex number 要搜索的图像索引.
Returns:
如果此图像集合包含给定的索引,则为True.
Type
boolean