Tileset

.Tilemaps. Tileset

平铺显示集是包含平铺显示的图像和数据容器的组合 每块瓷砖.

Constructor

new Tileset(name, firstgid, tileWidthopt, tileHeightopt, tileMarginopt, tileSpacingopt, tilePropertiesopt, tileDataopt)

Since:
  • 3.0.0
Parameters:
Name Type Attributes Default Description
name string 地图数据中波浪线的名称.
firstgid number 此tileset包含的第一个切片索引.
tileWidth number <optional>
32 每个图块的宽度(以像素为单位).
tileHeight number <optional>
32 每个图块的高度(以像素为单位).
tileMargin number <optional>
0 工作表中所有切片周围的边距(以像素为单位).
tileSpacing number <optional>
0 工作表中每个图块之间的间距(以像素为单位).
tileProperties object <optional>
{} Tileset中每个图块定义的自定义属性. 这些通常是编辑平铺显示集时在平铺显示中创建的自定义属性.
tileData object <optional>
{} 每个图块存储的数据.这些通常以平铺方式创建 编辑波形集时,例如.从平铺的平铺碰撞编辑器或地形编辑器.

Members

(readonly) columns :number

Since:
  • 3.0.0
平铺列表中的平铺列数.
Type:
  • number

firstgid :number

Since:
  • 3.0.0
此Tileset包含的第一个切片索引的起始索引.
Type:
  • number

(readonly, nullable) glTexture :WebGLTexture

Since:
  • 3.11.0
Webgl渲染器使用的GL纹理.
Type:
  • WebGLTexture

(readonly, nullable) image :Phaser.Textures.Texture

Since:
  • 3.0.0
包含单个切片的缓存图像.使用setImage设置.
Type:

name :string

Since:
  • 3.0.0
Tileset的名称.
Type:
  • string

(readonly) rows :number

Since:
  • 3.0.0
平铺列表中的平铺行数.
Type:
  • number

(readonly) texCoordinates :Array.<object>

Since:
  • 3.0.0
特定图块图像纹理坐标的查找表(单位为像素).每个元素 包含{x,y}形式的对象中图块的坐标.
Type:
  • Array.<object>

tileData :object

Since:
  • 3.0.0
通常在切片编辑器中定义的每个切片的切片特定数据,例如.在…的里面 Tileset碰撞编辑器.这是存储碰撞对象和地形的地方.
Type:
  • object

(readonly) tileHeight :number

Since:
  • 3.0.0
每个图块的高度(以像素为单位).使用setTileSize进行更改.
Type:
  • number

(readonly) tileMargin :number

Since:
  • 3.0.0
工作表中图块周围的边距(以像素为单位).使用 `setSpacing` 进行更改.
Type:
  • number

tileProperties :object

Since:
  • 3.0.0
中平铺编辑器中通常定义的每个平铺的特定于平铺的属性 Tileset编辑器.
Type:
  • object

(readonly) tileSpacing :number

Since:
  • 3.0.0
工作表中每个图块之间的间距(像素).使用 `setSpacing` 进行更改.
Type:
  • number

(readonly) tileWidth :number

Since:
  • 3.0.0
每个图块的宽度(以像素为单位).使用setTileSize进行更改.
Type:
  • number

(readonly) total :number

Since:
  • 3.0.0
平铺列表中的平铺总数.
Type:
  • number

Methods

containsTileIndex(tileIndex) → {boolean}

Since:
  • 3.0.0
当且仅当此Tileset包含给定的切片索引时,返回true.
Parameters:
Name Type Description
tileIndex number 地图中所有切片的切片的唯一id.
Returns:
Type
boolean

getTileCollisionGroup(tileIndex) → (nullable) {object}

Since:
  • 3.0.0
获取存储在Tileset中的图块的碰撞组.如果切片索引不是,则返回null 包含在此Tileset中.这通常是在平铺的tileset碰撞编辑器中定义的.
Parameters:
Name Type Description
tileIndex number 地图中所有切片的切片的唯一id.
Returns:
Type
object

getTileData(tileIndex) → {object|undefined}

Since:
  • 3.0.0
获取存储在平铺列表中的平铺数据.如果不包含切片索引,则返回null 在这个Tileset中.这通常在平铺中定义,将包含两个平铺冲突 信息和地形测绘.
Parameters:
Name Type Description
tileIndex number 地图中所有切片的切片的唯一id.
Returns:
Type
object | undefined

getTileProperties(tileIndex) → (nullable) {object|undefined}

Since:
  • 3.0.0
获取存储在Tileset中的切片属性.如果切片索引不是,则返回null 包含在此Tileset中.这通常是在Tileset编辑器下的平铺中定义的.
Parameters:
Name Type Description
tileIndex number 地图中所有切片的切片的唯一id.
Returns:
Type
object | undefined

getTileTextureCoordinates(tileIndex) → (nullable) {object}

Since:
  • 3.0.0
返回给定平铺索引的平铺图像中的纹理坐标(单位为像素). 如果此Tileset中不包含切片索引,则返回null.
Parameters:
Name Type Description
tileIndex number 地图中所有切片的切片的唯一id.
Returns:
Object in the form { x, y } representing the top-left UV coordinate 在Tileset图像中.
Type
object

setImage(texture) → {Phaser.Tilemaps.Tileset}

Since:
  • 3.0.0
设置与此平铺设置相关联的图像,并更新平铺数据(行,列等).
Parameters:
Name Type Description
texture Phaser.Textures.Texture 包含切片的图像.
Returns:
此Tileset对象.
Type
Phaser.Tilemaps.Tileset

setSpacing(marginopt, spacingopt) → {Phaser.Tilemaps.Tileset}

Since:
  • 3.0.0
设置图块边距和间距,并更新图块数据(行,列等).
Parameters:
Name Type Attributes Description
margin number <optional>
工作表中图块周围的边距(以像素为单位).
spacing number <optional>
工作表中图块之间的间距(以像素为单位).
Returns:
此Tileset对象.
Type
Phaser.Tilemaps.Tileset

setTileSize(tileWidthopt, tileHeightopt) → {Phaser.Tilemaps.Tileset}

Since:
  • 3.0.0
设置图块宽度和高度,并更新图块数据(行,列等).
Parameters:
Name Type Attributes Description
tileWidth number <optional>
以像素为单位的图块宽度.
tileHeight number <optional>
以像素为单位的图块高度.
Returns:
此Tileset对象.
Type
Phaser.Tilemaps.Tileset

updateTileData(imageWidth, imageHeight) → {Phaser.Tilemaps.Tileset}

Since:
  • 3.0.0
更新平铺纹理坐标和平铺数据.
Parameters:
Name Type Description
imageWidth number 要切片的图像的(预期)宽度.
imageHeight number 要切片的图像的(预期)高度.
Returns:
此Tileset对象.
Type
Phaser.Tilemaps.Tileset