@latticexyz/phaserx / AnimatedTilemap

# Interface: AnimatedTilemap<TileKeys, LayerKeys, AnimationKeys>

# Type parameters

Name Type
TileKeys extends number
LayerKeys extends string
AnimationKeys extends string

# Hierarchy

# Table of contents

# Properties

  • dispose
  • pauseAnimationAt
  • putAnimationAt
  • putTileAt
  • registerAnimation
  • removeAnimationAt
  • resumeAnimationAt
  • setVisible
  • size
  • tileHeight
  • tileWidth
  • tiles
  • visible

# Properties

# dispose

dispose: () => void

# Type declaration

▸ (): void

# Returns

void

# Inherited from

VirtualTilemap.dispose

# Defined in

packages/phaserx/src/tilemap/types.ts:7


# pauseAnimationAt

pauseAnimationAt: (coord: Coord, layer?: LayerKeys) => void

# Type declaration

▸ (coord, layer?): void

# Parameters
Name Type
coord Coord
layer? LayerKeys
# Returns

void

# Defined in

packages/phaserx/src/tilemap/types.ts:23


# putAnimationAt

putAnimationAt: (coord: Coord, animationKey: AnimationKeys, layer?: LayerKeys) => void

# Type declaration

▸ (coord, animationKey, layer?): void

# Parameters
Name Type
coord Coord
animationKey AnimationKeys
layer? LayerKeys
# Returns

void

# Defined in

packages/phaserx/src/tilemap/types.ts:21


# putTileAt

putTileAt: (coord: Coord, tile: TileKeys, layer?: LayerKeys, tint?: number) => void

# Type declaration

▸ (coord, tile, layer?, tint?): void

# Parameters
Name Type
coord Coord
tile TileKeys
layer? LayerKeys
tint? number
# Returns

void

# Inherited from

VirtualTilemap.putTileAt

# Defined in

packages/phaserx/src/tilemap/types.ts:6


# registerAnimation

registerAnimation: (animationKey: AnimationKeys, frames: TileAnimation<TileKeys>) => void

# Type declaration

▸ (animationKey, frames): void

# Parameters
Name Type
animationKey AnimationKeys
frames TileAnimation<TileKeys>
# Returns

void

# Defined in

packages/phaserx/src/tilemap/types.ts:25


# removeAnimationAt

removeAnimationAt: (coord: Coord, layer?: LayerKeys) => void

# Type declaration

▸ (coord, layer?): void

# Parameters
Name Type
coord Coord
layer? LayerKeys
# Returns

void

# Defined in

packages/phaserx/src/tilemap/types.ts:22


# resumeAnimationAt

resumeAnimationAt: (coord: Coord, layer?: LayerKeys) => void

# Type declaration

▸ (coord, layer?): void

# Parameters
Name Type
coord Coord
layer? LayerKeys
# Returns

void

# Defined in

packages/phaserx/src/tilemap/types.ts:24


# setVisible

setVisible: (visible: boolean) => void

# Type declaration

▸ (visible): void

# Parameters
Name Type
visible boolean
# Returns

void

# Inherited from

VirtualTilemap.setVisible

# Defined in

packages/phaserx/src/tilemap/types.ts:8


# size

size: () => number

# Type declaration

▸ (): number

# Returns

number

# Inherited from

VirtualTilemap.size

# Defined in

packages/phaserx/src/tilemap/types.ts:5


# tileHeight

tileHeight: number

# Inherited from

VirtualTilemap.tileHeight

# Defined in

packages/phaserx/src/tilemap/types.ts:11


# tileWidth

tileWidth: number

# Inherited from

VirtualTilemap.tileWidth

# Defined in

packages/phaserx/src/tilemap/types.ts:10


# tiles

tiles: { [key in string]: CoordMap<number> }

# Inherited from

VirtualTilemap.tiles

# Defined in

packages/phaserx/src/tilemap/types.ts:16


# visible

visible: Object

# Type declaration

Name Type
current boolean

# Inherited from

VirtualTilemap.visible

# Defined in

packages/phaserx/src/tilemap/types.ts:9