API Docs for: v0.1.0
Show:

Tilemap Class

Extends Container

Tiled map that represents an entire tile map with multiple layers or object groups. Often it is easier to create a tilemap using the object factor on a world, rather than doing it manually yourself.

Constructor

Tilemap

(
  • state
  • map
  • tilesetTextures
)

Parameters:

  • state State

    The game state the map belongs to

  • map Object

    All the settings for the map

  • tilesetTextures Object

    An object whose keys are the tileset name, and whose values are the textures for the tileset. For example: { tileset1: new Texture(), ... }

Methods

addChild

(
  • child
)
Container | Sprite

Adds a child to the container and returns the child

Parameters:

Returns:

Container | Sprite:

The child that was added

addChildAt

(
  • child
  • index
)
Container | Sprite

Adds a child to the object at a specified index. If the index is out of bounds an error will be thrown

Parameters:

Returns:

Container | Sprite:

The child that was added

bringChildToTop

(
  • child
)
Container | Sprite

Brings a child to the top of the Z pile.

Parameters:

Returns:

Container | Sprite:

The child that was added

clearTiles

() Tilemap chainable

Clears all the tiles that are currently used on all tile layers

Returns:

Tilemap:

Returns itself.

despawnObjects

() Tilemap chainable

Spawns all the objects in the ObjectGroups of this map

Returns:

Tilemap:

Returns itself.

destroy

()

Inherited from Container but overwritten in src\tilemap\Tilemap.js:177

Destroys the tilemap instance

destroyAllChildren

() Container chainable

Destroys all the children of the object.

Returns:

Container:

Returns itself.

disablePhysics

() Mixed chainable async

Inherited from PhysicsTarget but overwritten in src\physics\PhysicsTarget.js:83

Disbales physics for this sprite

Returns:

Mixed:

Returns itself.

emit

(
  • type
  • data
)
Mixed chainable

Emits an event which will run all registered listeners for the event type

Parameters:

  • type String

    The event name to emit

  • data Mixed

    Any data you want passed along with the event

Returns:

Mixed:

Returns itself.

enablePhysics

(
  • system
)
Mixed chainable async

Enables physics for this sprite

Parameters:

Returns:

Mixed:

Returns itself.

findLayer

(
  • name
)
Tilelayer | ObjectGroup | Sprite

Finds a layer based on the string name

Parameters:

  • name String

    The name of the layer to find

Returns:

Tilelayer | ObjectGroup | Sprite:

Returns the layer if found, undefined if not

getTileset

(
  • tileId
)
TiledTileset

Gets the tileset that an ID is associated with

Parameters:

  • tileId Number

    The id of the tile to find the tileset for

Returns:

TiledTileset:

Returns the tileset if found, undefined if not

hide

() Container chainable

Sets the container to visible = false

Returns:

Container:

Returns itself.

off

(
  • type
  • listener
)
Mixed chainable

Removes a listener function for an event type

Parameters:

  • type String

    The event name to emit

  • listener Function

    The function to remove

Returns:

Mixed:

Returns itself.

on

(
  • type
  • listener
)
Mixed chainable

Registers a listener function to be run on an event occurance

Parameters:

  • type String

    The event name to listen for

  • listener Function

    The function to execute when the event happens

Returns:

Mixed:

Returns itself.

once

(
  • type
  • listener
)
Mixed chainable

Registers a one-time callback for an event

Parameters:

  • type String

    The event name to listen for

  • listener Function

    the callback to call when the event occurs

Returns:

Mixed:

Returns itself.

onCollide

(
  • obj
  • collision
)
Boolean

Called whenever a collision occurs

Parameters:

  • obj Sprite | Container

    The sprite that you collide with

  • collision Collision

    Collision data object that contains information about the intersection

Returns:

Boolean:

If you return false explicitly the engine will not solve the collision. In this way you can make thing "not collide" if you don't want their types to collide.

onObjectEvent

(
  • eventName
  • obj
  • data
)
private

Called by a ObjectGroup when an object event occurs. This is so you can listen for the emitted events on the world instead of the tile itself.

Parameters:

  • eventName String

    The event name to emit, the prefix 'object.' will be added to it

  • obj Sprite | Container

    The object that has the event

  • data InteractionData

    The raw interaction object for the event

onTileEvent

(
  • eventName
  • tile
  • data
)
private

Called by a Tilelayer when a tile event occurs. This is so you can listen for the emitted events on the world instead of the tile itself.

Parameters:

  • eventName String

    The event name to emit, the prefix 'tile.' will be added to it

  • tile Tile

    The tile that has the event

  • data InteractionData

    The raw interaction object for the event

pan

(
  • x
  • y
)
Tilemap chainable

Pans the map around

Parameters:

  • x Number | Point

    The x amount to pan, if a Point is passed the y param is ignored

  • y Number

    The y ammount to pan

Returns:

Tilemap:

Returns itself.

removeAllChildren

() Container chainable

Removes all children from the object.

Returns:

Container:

Returns itself.

removeChild

(
  • child
)
Container | Sprite

Removes a child from the object.

Parameters:

Returns:

Container | Sprite:

The child that was added

render

(
  • x
  • y
  • width
  • height
)
Tilemap chainable

Called on resize to render the viewport again

Parameters:

  • x Number

    The x offset to consider the top-left

  • y Number

    The y offset to consider the top-left

  • width Number

    The width (in pixels) to render

  • height Number

    The height (in pixels) to render

Returns:

Tilemap:

Returns itself.

setMass

(
  • mass
)
Mixed chainable

Sets the mass of this sprite

Parameters:

  • mass Number

    The new mass of the object

Returns:

Mixed:

Returns itself.

setPosition

(
  • x
  • y
)
Mixed chainable

Sets the position of this sprite

Parameters:

  • x Number
  • y Number

Returns:

Mixed:

Returns itself.

setRotation

(
  • rotation
)
Mixed chainable

Sets the rotation of this sprite

Parameters:

  • rotation Number

    The new rotation of the object in radians

Returns:

Mixed:

Returns itself.

setVelocity

(
  • velocity
)
Mixed chainable

Sets the velocity of this sprite

Parameters:

  • velocity Vector

    The new velocity of the object

Returns:

Mixed:

Returns itself.

show

() Container chainable

Sets the container to visible = true

Returns:

Container:

Returns itself.

spawnObjects

() Tilemap chainable

Spawns all the objects in the ObjectGroups of this map

Returns:

Tilemap:

Returns itself.

Properties

_phys

Object private

The physics namespace that all physics properties go into. Those properties are:

  • system {PhysicsSystem} PhysicsSystem that this object is a part of.
  • active {Boolean} Whether or not this target is actively having physics simulated.

Default: {}

alpha

Number

The opacity of the object.

backgroundColor

Number

The background color of the map (since Tiled 0.9.0)

children

Array

[read-only] The of children of this object.

game

Game

The game instance this tilemap belongs to

hitArea

Rectangle | Polygon | Circle | Ellipse

This is the defined area that will pick up mouse / touch events. It is null by default. Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)

inertia

Number

The moment of inertia of this object, only set this before enabling physics (has no effect after enabling)

Default: 0

interactive

Boolean

Wether or not the object will handle mouse events

Default: false

mass

Number

The mass of this object, please use setMass to set this value

Default: 0

orientation

String

The orientation of the map

parent

DisplayObject

[read-only] The display object that contains this display object.

position

Point

The coordinate of the object relative to the local coordinates of the parent.

properties

Object

The user-defined properties

Default: {}

realSize

Vector

The real size (size * scaledTileSize)

rotation

Number

The rotation of the object in radians.

scale

Point

The scale factor of the object.

scaledTileSize

Vector

The scaled tile size

size

Vector

The size of the map

Default: new Vector(0, 0)

stage

Stage

[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.

state

Game

The state instance this tilemap belongs to

tilesets

Array

The tilesets used by this map

tileSize

Vector

The tile size

version

Number

The version of the TMX format

visible

Boolean

The visibility of the object.

Events

click

A callback that is used when the users clicks on the displayObject with their mouse

Event Payload:

  • interactionData InteractionData

collision

On Collision Event called when this sprite collides into another, or is being collided into by another. By default if something collides with a collectable sprite we destroy the collectable and if we collide with a solid tile we kill our velocity. This method will emit a 'collision' event that you can listen for

Event Payload:

  • obj Sprite

    Colliding sprite

  • vec Vector

    Collision vector (for sensors this is normalized)

  • colShape cp.Shape

    The colliding physics shape

  • myShape cp.Shape

    Your physics shape that caused the collision

mousedown

A callback that is used when the user clicks the mouse down over the displayObject

Event Payload:

  • interactionData InteractionData

mousemove

A callback that is used when the user moves the mouse while over the displayObject

Event Payload:

  • interactionData InteractionData

mouseout

A callback that is used when the users mouse leaves the displayObject

Event Payload:

  • interactionData InteractionData

mouseover

A callback that is used when the users mouse rolls over the displayObject

Event Payload:

  • interactionData InteractionData

mouseup

A callback that is used when the user releases the mouse that was over the displayObject for this callback to be fired the mouse must have been pressed down over the displayObject

Event Payload:

  • interactionData InteractionData

mouseupoutside

A callback that is used when the user releases the mouse that was over the displayObject but is no longer over the displayObject for this callback to be fired, The touch must have started over the displayObject

Event Payload:

  • interactionData InteractionData

separate

On Seperate Event called when this sprite collides into another, or is being collided into by another. By default if something collides with a collectable sprite we destroy the collectable and if we collide with a solid tile we kill our velocity. This method will emit a 'collision' event that you can listen for

Event Payload:

  • obj Sprite

    Colliding sprite

  • colShape cp.Shape

    The colliding physics shape

  • myShape cp.Shape

    Your physics shape that caused the collision

tap

A callback that is used when the users taps on the displayObject with their finger basically a touch version of click

Event Payload:

  • interactionData InteractionData

touchend

A callback that is used when the user releases a touch over the displayObject

Event Payload:

  • interactionData InteractionData

touchendoutside

A callback that is used when the user releases the touch that was over the displayObject for this callback to be fired, The touch must have started over the displayObject

Event Payload:

  • interactionData InteractionData

touchstart

A callback that is used when the user touch's over the displayObject

Event Payload:

  • interactionData InteractionData