Tilemap

Creates a new Phaser.Tilemap object. The map can either be populated with data from a Tiled JSON file or from a CSV file.

Tiled is a free software package specifically for creating tile maps, and is available from http://www.mapeditor.org

To do this pass the Cache key as the first parameter. When using Tiled data you need only provide the key. When using CSV data you must provide the key and the tileWidth and tileHeight parameters. If creating a blank tilemap to be populated later, you can either specify no parameters at all and then use Tilemap.create or pass the map and tile dimensions here.

Note that all Tilemaps use a base tile size to calculate dimensions from, but that a TilemapLayer may have its own unique tile size that overrides it.

A Tile map is rendered to the display using a TilemapLayer. It is not added to the display list directly itself. A map may have multiple layers. You can perform operations on the map data such as copying, pasting, filling and shuffling the tiles around.

Annotations: @RawJSType() @native() @JSName( "Phaser.Tilemap" )
See also: http://phaser.io/docs/2.6.2/Phaser.Tilemap.html

Linear Supertypes

Object, Any, AnyRef, Any

Instance Constructors

new Tilemap(game: Phaser.Game, key: String = js.native, tileWidth: Double = js.native, tileHeight: Double = js.native, width: Double = js.native, height: Double = js.native)

game
Game reference to the currently running game.
key
The key of the tilemap data as stored in the Cache. If you're creating a blank map either leave this parameter out or pass null.
tileWidth
The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.
tileHeight
The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.
width
The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.
height
The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
var collideIndexes: Array[Int]

An array of tile indexes that collide.
var collision: Array[_]

An array of collision data (polylines, etc).
var currentLayer: Int

The current layer.
var debugMap: Array[_]

Map data used for debug values only.
var enableDebug: Boolean

If set then console.log is used to dump out useful layer creation debug data.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
var game: Phaser.Game

Game reference to the currently running game.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
var height: Double

The height of the map in tiles.
The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
var key: String

The key of the tilemap data as stored in the Cache.
The key of the tilemap data as stored in the Cache. If you're creating a blank map either leave this parameter out or pass null.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
var tileHeight: Double

The pixel height of a single map tile.
The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.
var tileWidth: Double

The pixel width of a single map tile.
The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
def valueOf(): Any

Definition Classes
Object
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
var width: Double

The width of the map in tiles.
The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.

Related Docs: object Tilemap | package phaser

class Tilemap extends Object

Instance Constructors

new Tilemap(game: Phaser.Game, key: String = js.native, tileWidth: Double = js.native, tileHeight: Double = js.native, width: Double = js.native, height: Double = js.native)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

var collideIndexes: Array[Int]

var collision: Array[_]

var currentLayer: Int

var debugMap: Array[_]

var enableDebug: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

var game: Phaser.Game

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

var height: Double

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

var key: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def propertyIsEnumerable(v: String): Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

var tileHeight: Double

var tileWidth: Double

def toLocaleString(): String

def toString(): String

def valueOf(): Any

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

var width: Double

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped