Members

alpha :number

The alpha value at which this tile is drawn to the canvas.

Source - tilemap/Tile.js, line 74

<readonly> bottom :number

The sum of the y and height properties.

Source - tilemap/Tile.js, line 386

<readonly> canCollide :boolean

True if this tile can collide on any of its faces or has a collision callback set.

Source - tilemap/Tile.js, line 334

centerX

Properties:

Name	Type	Description
width	number	The width of the tile in pixels.

Source - tilemap/Tile.js, line 64

centerY

Properties:

Name	Type	Description
height	number	The height of the tile in pixels.

Source - tilemap/Tile.js, line 69

collideDown :boolean

Indicating collide with any object on the bottom.

Default Value:

• false

Source - tilemap/Tile.js, line 128

collideLeft :boolean

Indicating collide with any object on the left.

Default Value:

• false

Source - tilemap/Tile.js, line 110

collideRight :boolean

Indicating collide with any object on the right.

Default Value:

• false

Source - tilemap/Tile.js, line 116

<readonly> collides :boolean

True if this tile can collide on any of its faces.

Source - tilemap/Tile.js, line 321

collideUp :boolean

Indicating collide with any object on the top.

Default Value:

• false

Source - tilemap/Tile.js, line 122

collisionCallback :function

Tile collision callback.

Default Value:

• null

Source - tilemap/Tile.js, line 134

collisionCallbackContext :object

The context in which the collision callback will be called.

Source - tilemap/Tile.js, line 140

faceBottom :boolean

Is the bottom of this tile an interesting edge?

Source - tilemap/Tile.js, line 94

faceLeft :boolean

Is the left of this tile an interesting edge?

Source - tilemap/Tile.js, line 99

faceRight :boolean

Is the right of this tile an interesting edge?

Source - tilemap/Tile.js, line 104

faceTop :boolean

Is the top of this tile an interesting edge?

Source - tilemap/Tile.js, line 89

height :number

The height of the tile in pixels.

Source - tilemap/Tile.js, line 59

index :number

The index of this tile within the map data corresponding to the tileset, or -1 if this represents a blank/null tile.

Source - tilemap/Tile.js, line 29

layer :object

The layer in the Tilemap data that this tile belongs to.

Source - tilemap/Tile.js, line 24

<readonly> left :number

The x value in pixels.

Source - tilemap/Tile.js, line 347

properties :object

Tile specific properties.

Source - tilemap/Tile.js, line 79

<readonly> right :number

The sum of the x and width properties.

Source - tilemap/Tile.js, line 360

scanned :boolean

Has this tile been walked / turned into a poly?

Source - tilemap/Tile.js, line 84

<readonly> top :number

The y value.

Source - tilemap/Tile.js, line 373

width :number

The width of the tile in pixels.

Source - tilemap/Tile.js, line 54

worldX

Properties:

Name	Type	Description
x	number	The x map coordinate of this tile.

Source - tilemap/Tile.js, line 44

worldY

Properties:

Name	Type	Description
y	number	The y map coordinate of this tile.

Source - tilemap/Tile.js, line 49

x :number

The x map coordinate of this tile.

Source - tilemap/Tile.js, line 34

y :number

The y map coordinate of this tile.

Source - tilemap/Tile.js, line 39

Methods

containsPoint(x, y) → {boolean}

Check if the given x and y world coordinates are within this Tile.

Parameters:

Name	Type	Description
x	number	The x coordinate to test.
y	number	The y coordinate to test.

Returns:

boolean -

True if the coordinates are within this Tile, otherwise false.

Source - tilemap/Tile.js, line 146

copy(tile)

Copies the tile data and properties from the given tile to this tile.

Parameters:

Name	Type	Description
tile	Phaser.Tile	The tile to copy from.

Source - tilemap/Tile.js, line 295

destroy()

Clean up memory.

Source - tilemap/Tile.js, line 210

intersects(x, y, right, bottom)

Check for intersection with this tile.

Parameters:

Name	Type	Description
x	number	The x axis in pixels.
y	number	The y axis in pixels.
right	number	The right point.
bottom	number	The bottom point.

Source - tilemap/Tile.js, line 160

isInteresting(collides, faces) → {boolean}

Is this tile interesting?

Parameters:

Name	Type	Description
collides	boolean	If true will check any collides value.
faces	boolean	If true will check any face value.

Returns:

boolean -

True if the Tile is interesting, otherwise false.

Source - tilemap/Tile.js, line 265

resetCollision()

Reset collision status flags.

Source - tilemap/Tile.js, line 246

setCollision(left, right, up, down)

Sets the collision flags for each side of this tile and updates the interesting faces list.

Parameters:

Name	Type	Description
left	boolean	Indicating collide with any object on the left.
right	boolean	Indicating collide with any object on the right.
up	boolean	Indicating collide with any object on the top.
down	boolean	Indicating collide with any object on the bottom.

Source - tilemap/Tile.js, line 223

setCollisionCallback(callback, context)

Set a callback to be called when this tile is hit by an object. The callback must true true for collision processing to take place.

Parameters:

Name	Type	Description
callback	function	Callback function.
context	object	Callback will be called within this context.

Source - tilemap/Tile.js, line 195