A TilemapLayer is a Phaser.Image/Sprite that renders a specific TileLayer of a Tilemap.
Since a TilemapLayer is a Sprite it can be moved around the display, added to other groups or display objects, etc.
By default TilemapLayers have fixedToCamera set to true. Changing this will break Camera follow and scrolling behavior.
| Name | Type | Description |
|---|---|---|
game | Phaser.Game | Game reference to the currently running game. |
tilemap | Phaser.Tilemap | The tilemap to which this layer belongs. |
index | integer | The index of the TileLayer to render within the Tilemap. |
width | integer | Width of the renderable area of the layer (in pixels). |
height | integer | Height of the renderable area of the layer (in pixels). |
A useful flag to control if the Game Object is alive or dead.
This is set automatically by the Health components damage method should the object run out of health.
Or you can toggle it via your game code.
This property is mostly just provided to be used by your game - it doesn't effect rendering or logic updates.
However you can use Group.getFirstAlive in conjunction with this property for fast object pooling and recycling.
The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting than anchor to 0.5,0.5 means the textures origin is centered
Setting the anchor to 1,1 would mean the textures origin points will be the bottom right corner
The angle property is the rotation of the Game Object in degrees from its original orientation.
Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
Values outside this range are added to or subtracted from 360 to obtain a value within the range.
For example, the statement player.angle = 450 is the same as player.angle = 90.
If you wish to work in radians instead of degrees you can use the property rotation instead.
Working in radians is slightly faster as it doesn't have to perform any calculations.
If the Game Object is enabled for animation (such as a Phaser.Sprite) this is a reference to its AnimationManager instance.
Through it you can create, play, pause and stop animations.
A Game Object with autoCull set to true will check its bounds against the World Camera every frame.
If it is not intersecting the Camera bounds at any point then it has its renderable property set to false.
This keeps the Game Object alive and still processing updates, but forces it to skip the render step entirely.
This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
or you have tested performance and find it acceptable.
The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.
Warning: You cannot have a blend mode and a filter active on the same Sprite. Doing so will render the sprite invisible.
body is the Game Objects physics body. Once a Game Object is enabled for physics you access all associated
properties and methods via it.
By default Game Objects won't add themselves to any physics system and their body property will be null.
To enable this Game Object for physics you need to call game.physics.enable(object, system) where object is this object
and system is the Physics system you are using. If none is given it defaults to Phaser.Physics.Arcade.
You can alternatively call game.physics.arcade.enable(object), or add this Game Object to a physics enabled Group.
Important: Enabling a Game Object for P2 or Ninja physics will automatically set its anchor property to 0.5,
so the physics body is centered on the Game Object.
If you need a different result then adjust or re-create the Body shape offsets manually or reset the anchor after enabling physics.
The sum of the y and height properties.
This is the same as y + height - offsetY.
The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if fixedToCamera is true.
The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.
The canvas to which this TilemapLayer draws.
The center x coordinate of the Game Object.
This is the same as (x - offsetX) + (width / 2).
The center y coordinate of the Game Object.
This is the same as (y - offsetY) + (height / 2).
If this is set to true the Game Object checks if it is within the World bounds each frame.
When it is no longer intersecting the world bounds it dispatches the onOutOfBounds event.
If it was previously out of bounds but is now intersecting the world bounds again it dispatches the onEnterBounds event.
It also optionally kills the Game Object if outOfBoundsKill is true.
When checkWorldBounds is enabled it forces the Game Object to calculate its full bounds every frame.
This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
or you have tested performance and find it acceptable.
[read-only] The array of children of this container.
The components this Game Object has installed.
The Rectangle used to crop the texture this Game Object uses.
Set this property via crop.
If you modify this property directly you must call updateCrop in order to have the change take effect.
Damages the Game Object. This removes the given amount of health from the health property.
If health is taken below or is equal to zero then the kill method is called.
An empty Object that belongs to this Game Object.
This value isn't ever used internally by Phaser, but may be used by your own code, or
by Phaser Plugins, to store data that needs to be associated with the Game Object,
without polluting the Game Object directly.
Enable an additional "debug rendering" pass to display collision information.
Settings used for debugging and diagnostics.
| Name | Type | Argument | Description |
|---|---|---|---|
missingImageFill | string | <nullable> | A tile is rendered as a rectangle using the following fill if a valid tileset/image cannot be found. A value of |
debuggedTileOverfill | string | <nullable> | If a Tile has |
forceFullRedraw | boolean | When debug rendering ( | |
debugAlpha | number | When debug rendering ( | |
facingEdgeStroke | string | <nullable> | When debug rendering ( |
collidingTileOverfill | string | <nullable> | When debug rendering ( |
Returns the delta x value. The difference between world.x now and in the previous frame.
The value will be positive if the Game Object has moved to the right or negative if to the left.
Returns the delta y value. The difference between world.y now and in the previous frame.
The value will be positive if the Game Object has moved down or negative if up.
Returns the delta z value. The difference between rotation now and in the previous frame. The delta value.
As a Game Object runs through its destroy method this flag is set to true,
and can be checked in any sub-systems or plugins it is being destroyed from.
If true tiles will be force rendered, even if such is not believed to be required.
All Phaser Game Objects have an Events class which contains all of the events that are dispatched when certain things happen to this
Game Object, or any of its components.
Controls if the core game loop and physics update this game object or not.
A Game Object that is "fixed" to the camera uses its x/y coordinates as offsets from the top left of the camera during rendering.
The values are adjusted at the rendering stage, overriding the Game Objects actual world position.
The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
regardless where in the world the camera is.
The offsets are stored in the cameraOffset property.
Note that the cameraOffset values are in addition to any parent of this Game Object on the display list.
Be careful not to set fixedToCamera on Game Objects which are in Groups that already have fixedToCamera enabled on them.
Gets or sets the current frame index of the texture being used to render this Game Object.
To change the frame set frame to the index of the new frame in the sprite sheet you wish this Game Object to use,
for example: player.frame = 4.
If the frame index given doesn't exist it will revert to the first frame found in the texture.
If you are using a texture atlas then you should use the frameName property instead.
If you wish to fully replace the texture being used see loadTexture.
Gets or sets the current frame name of the texture being used to render this Game Object.
To change the frame set frameName to the name of the new frame in the texture atlas you wish this Game Object to use,
for example: player.frameName = "idle".
If the frame name given doesn't exist it will revert to the first frame found in the texture and throw a console warning.
If you are using a sprite sheet then you should use the frame property instead.
If you wish to fully replace the texture being used see loadTexture.
A Game Object is considered fresh if it has just been created or reset and is yet to receive a renderer transform update.
This property is mostly used internally by the physics systems, but is exposed for the use of plugins.
A reference to the currently running Game.
Heal the Game Object. This adds the given amount of health to the health property.
The Game Objects health value. This is a handy property for setting and manipulating health on a Game Object.
It can be used in combination with the damage method or modified directly.
The height of the sprite, setting this will actually modify the scale to achieve the value set
If ignoreChildInput is false it will allow this objects children to be considered as valid for Input events.
If this property is true then the children will not be considered as valid for Input events.
Note that this property isn't recursive: only immediate children are influenced, it doesn't scan further down.
Checks if the Game Objects bounds intersect with the Game Camera bounds.
Returns true if they do, otherwise false if fully outside of the Cameras bounds.
The index of this layer within the Tilemap.
The Input Handler for this Game Object.
By default it is disabled. If you wish this Game Object to process input events you should enable it with: inputEnabled = true.
After you have done this, this property will be a reference to the Phaser InputHandler.
By default a Game Object won't process any input events. By setting inputEnabled to true a Phaser.InputHandler is created
for this Game Object and it will then start to process click / touch events and more.
You can then access the Input Handler via this.input.
Note that Input related events are dispatched from this.events, i.e.: events.onInputDown.
If you set this property to false it will stop the Input Handler from processing any more input events.
If you want to temporarily disable input for a Game Object, then it's better to setinput.enabled = false, as it won't reset any of the Input Handlers internal properties.
You can then toggle this back on as needed.
Checks if the Game Objects bounds are within, or intersect at any point with the Game World bounds.
The key of the image or texture used by this Game Object during rendering.
If it is a string it's the string used to retrieve the texture from the Phaser Image Cache.
It can also be an instance of a RenderTexture, BitmapData, Video or PIXI.Texture.
If a Game Object is created without a key it is automatically assigned the key __default which is a 32x32 transparent PNG stored within the Cache.
If a Game Object is given a key which doesn't exist in the Image Cache it is re-assigned the key __missing which is a 32x32 PNG of a green box with a line through it.
The layer object within the Tilemap that this layer represents.
The left coordinate of the Game Object.
This is the same as x - offsetX.
The lifespan allows you to give a Game Object a lifespan in milliseconds.
Once the Game Object is 'born' you can set this to a positive value.
It is automatically decremented by the millisecond equivalent of game.time.physicsElapsed each frame.
When it reaches zero it will call the kill method.
Very handy for particles, bullets, collectibles, or any other short-lived entity.
The Tilemap to which this layer is bound.
The Game Objects maximum health value. This works in combination with the heal method to ensure
the health value never exceeds the maximum.
A user defined name given to this Game Object.
This value isn't ever used internally by Phaser, it is meant as a game level property.
The amount the Game Object is visually offset from its x coordinate.
This is the same as width * anchor.x.
It will only be > 0 if anchor.x is not equal to zero.
The amount the Game Object is visually offset from its y coordinate.
This is the same as height * anchor.y.
It will only be > 0 if anchor.y is not equal to zero.
If this and the checkWorldBounds property are both set to true then the kill method is called as soon as inWorld returns false.
If this and the autoCull property are both set to true, then the kill method
is called as soon as the Game Object leaves the camera bounds.
A Game Object is that is pendingDestroy is flagged to have its destroy method called on the next logic update.
You can set it directly to allow you to flag an object to be destroyed on its next update.
This is extremely useful if you wish to destroy an object from within one of its own callbacks
such as with Buttons or other Input events.
The const physics body type of this object.
The position the Game Object was located in the previous frame.
The rotation the Game Object was in set to in the previous frame. Value is in radians.
When ray-casting against tiles this is the number of steps it will jump. For larger tile sizes you can increase this to improve performance.
The render order ID is used internally by the renderer and Input Manager and should not be modified.
This property is mostly used internally by the renderers, but is exposed for the use of plugins.
Settings that control standard (non-diagnostic) rendering.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
enableScrollDelta | boolean | <optional> | true | Delta scroll rendering only draws tiles/edges as they come into view. |
copyCanvas | DOMCanvasElement | <optional> <nullable> | (auto) | [Internal] If set, force using a separate (shared) copy canvas. |
The right coordinate of the Game Object.
This is the same as x + width - offsetX.
The maximum scale this Game Object will scale up to.
It allows you to prevent a parent from scaling this Game Object higher than the given value.
Set it to null to remove the limit.
The minimum scale this Game Object will scale down to.
It allows you to prevent a parent from scaling this Game Object lower than the given value.
Set it to null to remove the limit.
Speed at which this layer scrolls horizontally, relative to the camera (e.g. scrollFactorX of 0.5 scrolls half as quickly as the 'normal' camera-locked layers do).
Speed at which this layer scrolls vertically, relative to the camera (e.g. scrollFactorY of 0.5 scrolls half as quickly as the 'normal' camera-locked layers do)
Sets the health property of the Game Object to the given amount.
Will never exceed the maxHealth value.
The shader that will be used to render this Sprite.
Set to null to remove a current shader.
Enable or disable texture smoothing for this Game Object.
It only takes effect if the Game Object is using an image based texture.
Smoothing is enabled by default.
The texture that the sprite is using
The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.
A canvas that contains the tinted version of the Sprite (in Canvas mode, WebGL doesn't populate this)
The y coordinate of the Game Object.
This is the same as y - offsetY.
The callback that will apply any scale limiting to the worldTransform.
The context under which transformCallback is called.
The const type of this object.
The width of the sprite, setting this will actually modify the scale to achieve the value set
The world coordinates of this Game Object in pixels.
Depending on where in the display list this Game Object is placed this value can differ from position,
which contains the x/y coordinates relative to the Game Objects parent.
The position of the Game Object on the x axis relative to the local coordinates of the parent.
The position of the Game Object on the y axis relative to the local coordinates of the parent.
The z depth of this Game Object within its parent Group.
No two objects in a Group can have the same z value.
This value is adjusted automatically whenever the Group hierarchy changes.
If you wish to re-order the layering of a Game Object then see methods like Group.moveUp or Group.bringToTop.
Adds a child to the container.
| Name | Type | Description |
|---|---|---|
child | DisplayObject | The DisplayObject to add to the container |
The child that was added.
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
| Name | Type | Description |
|---|---|---|
child | DisplayObject | The child to add |
index | Number | The index to place the child in |
The child that was added.
Aligns this Game Object within another Game Object, or Rectangle, known as the
'container', to one of 9 possible positions.
The container must be a Game Object, or Phaser.Rectangle object. This can include properties
such as World.bounds or Camera.view, for aligning Game Objects within the world
and camera bounds. Or it can include other Sprites, Images, Text objects, BitmapText,
TileSprites or Buttons.
Please note that aligning a Sprite to another Game Object does not make it a child of
the container. It simply modifies its position coordinates so it aligns with it.
The position constants you can use are:
Phaser.TOP_LEFT, Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER,Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT,Phaser.BOTTOM_CENTER and Phaser.BOTTOM_RIGHT.
The Game Objects are placed in such a way that their bounds align with the
container, taking into consideration rotation, scale and the anchor property.
This allows you to neatly align Game Objects, irrespective of their position value.
The optional offsetX and offsetY arguments allow you to apply extra spacing to the final
aligned position of the Game Object. For example:
sprite.alignIn(background, Phaser.BOTTOM_RIGHT, -20, -20)
Would align the sprite to the bottom-right, but moved 20 pixels in from the corner.
Think of the offsets as applying an adjustment to the containers bounds before the alignment takes place.
So providing a negative offset will 'shrink' the container bounds by that amount, and providing a positive
one expands it.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
container | Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite | The Game Object or Rectangle with which to align this Game Object to. Can also include properties such as | ||
position | integer | <optional> | The position constant. One of | |
offsetX | integer | <optional> | 0 | A horizontal adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it. |
offsetY | integer | <optional> | 0 | A vertical adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it. |
This Game Object.
Aligns this Game Object to the side of another Game Object, or Rectangle, known as the
'parent', in one of 11 possible positions.
The parent must be a Game Object, or Phaser.Rectangle object. This can include properties
such as World.bounds or Camera.view, for aligning Game Objects within the world
and camera bounds. Or it can include other Sprites, Images, Text objects, BitmapText,
TileSprites or Buttons.
Please note that aligning a Sprite to another Game Object does not make it a child of
the parent. It simply modifies its position coordinates so it aligns with it.
The position constants you can use are:
Phaser.TOP_LEFT (default), Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_TOP,Phaser.LEFT_CENTER, Phaser.LEFT_BOTTOM, Phaser.RIGHT_TOP, Phaser.RIGHT_CENTER,Phaser.RIGHT_BOTTOM, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER
and Phaser.BOTTOM_RIGHT.
The Game Objects are placed in such a way that their bounds align with the
parent, taking into consideration rotation, scale and the anchor property.
This allows you to neatly align Game Objects, irrespective of their position value.
The optional offsetX and offsetY arguments allow you to apply extra spacing to the final
aligned position of the Game Object. For example:
sprite.alignTo(background, Phaser.BOTTOM_RIGHT, -20, -20)
Would align the sprite to the bottom-right, but moved 20 pixels in from the corner.
Think of the offsets as applying an adjustment to the parents bounds before the alignment takes place.
So providing a negative offset will 'shrink' the parent bounds by that amount, and providing a positive
one expands it.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
parent | Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite | The Game Object or Rectangle with which to align this Game Object to. Can also include properties such as | ||
position | integer | <optional> | The position constant. One of | |
offsetX | integer | <optional> | 0 | A horizontal adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it. |
offsetY | integer | <optional> | 0 | A vertical adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it. |
This Game Object.
Brings this Game Object to the top of its parents display list.
Visually this means it will render over the top of any old child in the same Group.
If this Game Object hasn't been added to a custom Group then this method will bring it to the top of the Game World,
because the World is the root Group from which all Game Objects descend.
This instance.
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
| Name | Type | Description |
|---|---|---|
child | DisplayObject | - |
Crop allows you to crop the texture being used to display this Game Object.
Setting a crop rectangle modifies the core texture frame. The Game Object width and height properties will be adjusted accordingly.
Cropping takes place from the top-left and can be modified in real-time either by providing an updated rectangle object to this method,
or by modifying cropRect property directly and then calling updateCrop.
The rectangle object given to this method can be either a Phaser.Rectangle or any other object
so long as it has public x, y, width, height, right and bottom properties.
A reference to the rectangle is stored in cropRect unless the copy parameter is true,
in which case the values are duplicated to a local object.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
rect | Phaser.Rectangle | The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle. | ||
copy | boolean | <optional> | false | If false |
Destroys this TilemapLayer.
Create if needed (and return) a shared copy canvas that is shared across all TilemapLayers.
Code that uses the canvas is responsible to ensure the dimensions and save/restore state as appropriate.
Returns the bounds of the Sprite as a rectangle.
The bounds calculation takes the worldTransform into account.
It is important to note that the transform is not updated when you call this method.
So if this Sprite is the child of a Display Object which has had its transform
updated since the last render pass, those changes will not yet have been applied
to this Sprites worldTransform. If you need to ensure that all parent transforms
are factored into this getBounds operation then you should call updateTransform
on the root most object in this Sprites display list first.
| Name | Type | Description |
|---|---|---|
matrix | Matrix | the transformation matrix of the sprite |
the framing rectangle
Returns the child at the specified index
| Name | Type | Description |
|---|---|---|
index | Number | The index to get the child from |
The child at the given index, if any.
Returns the index position of a child DisplayObject instance
| Name | Type | Description |
|---|---|---|
child | DisplayObject | The DisplayObject instance to identify |
The index position of the child display object to identify
Retrieves the non-global local bounds of the Sprite as a rectangle. The calculation takes all visible children into consideration.
The rectangular bounding area
Gets all tiles that intersect with the given line.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
line | Phaser.Line | The line used to determine which tiles to return. | ||
stepRate | integer | <optional> | (rayStepRate) | How many steps through the ray will we check? Defaults to |
collides | boolean | <optional> | false | If true, only return tiles that collide on one or more faces. |
interestingFace | boolean | <optional> | false | If true, only return tiles that have interesting faces. |
An array of Phaser.Tiles.
Get all tiles that exist within the given area, defined by the top-left corner, width and height. Values given are in pixels, not tiles.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
x | number | X position of the top left corner (in pixels). | ||
y | number | Y position of the top left corner (in pixels). | ||
width | number | Width of the area to get (in pixels). | ||
height | number | Height of the area to get (in pixels). | ||
collides | boolean | <optional> | false | If true, only return tiles that collide on one or more faces. |
interestingFace | boolean | <optional> | false | If true, only return tiles that have interesting faces. |
An array of Tiles.
Convert a pixel value to a tile coordinate.
| Name | Type | Description |
|---|---|---|
x | number | X position of the point in target tile (in pixels). |
The X map location of the tile.
Convert a pixel coordinate to a tile coordinate.
| Name | Type | Description |
|---|---|---|
x | number | X position of the point in target tile (in pixels). |
y | number | Y position of the point in target tile (in pixels). |
point | Phaser.Point | object | The Point/object to update. |
A Point/object with its x and y properties set.
Convert a pixel value to a tile coordinate.
| Name | Type | Description |
|---|---|---|
y | number | Y position of the point in target tile (in pixels). |
The Y map location of the tile.
Kills a Game Object. A killed Game Object has its alive, exists and visible properties all set to false.
It will dispatch the onKilled event. You can listen to events.onKilled for the signal.
Note that killing a Game Object is a way for you to quickly recycle it in an object pool,
it doesn't destroy the object or free it up from memory.
If you don't need this Game Object any more you should call destroy instead.
This instance.
Changes the base texture the Game Object is using. The old texture is removed and the new one is referenced or fetched from the Cache.
If your Game Object is using a frame from a texture atlas and you just wish to change to another frame, then see the frame or frameName properties instead.
You should only use loadTexture if you want to replace the base texture entirely.
Calling this method causes a WebGL texture update, so use sparingly or in low-intensity portions of your game, or if you know the new texture is already on the GPU.
You can use the new const Phaser.PENDING_ATLAS as the texture key for any sprite.
Doing this then sets the key to be the frame argument (the frame is set to zero).
This allows you to create sprites using load.image during development, and then change them
to use a Texture Atlas later in development by simply searching your code for 'PENDING_ATLAS'
and swapping it to be the key of the atlas data.
Note: You cannot use a RenderTexture as a texture for a TileSprite.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
key | string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture | This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache Image entry, or an instance of a RenderTexture, BitmapData, Video or PIXI.Texture. | ||
frame | string | number | <optional> | If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index. | |
stopAnimation | boolean | <optional> | true | If an animation is already playing on this Sprite you can choose to stop it or let it carry on playing. |
Moves this Game Object down one place in its parents display list.
This call has no effect if the Game Object is already at the bottom of the display list.
If this Game Object hasn't been added to a custom Group then this method will move it one object down within the Game World,
because the World is the root Group from which all Game Objects descend.
This instance.
Moves this Game Object up one place in its parents display list.
This call has no effect if the Game Object is already at the top of the display list.
If this Game Object hasn't been added to a custom Group then this method will move it one object up within the Game World,
because the World is the root Group from which all Game Objects descend.
This instance.
Checks to see if the bounds of this Game Object overlaps with the bounds of the given Display Object,
which can be a Sprite, Image, TileSprite or anything that extends those such as Button or provides a getBounds method and result.
This check ignores the hitArea property if set and runs a getBounds comparison on both objects to determine the result.
Therefore it's relatively expensive to use in large quantities, i.e. with lots of Sprites at a high frequency.
It should be fine for low-volume testing where physics isn't required.
| Name | Type | Description |
|---|---|---|
displayObject | Phaser.Sprite | Phaser.Image | Phaser.TileSprite | Phaser.Button | PIXI.DisplayObject | The display object to check against. |
True if the bounds of this Game Object intersects at any point with the bounds of the given display object.
Plays an Animation.
The animation should have previously been created via animations.add.
If the animation is already playing calling this again won't do anything.
If you need to reset an already running animation do so directly on the Animation object itself or via AnimationManager.stop.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
name | string | The name of the animation to be played, e.g. "fire", "walk", "jump". Must have been previously created via 'AnimationManager.add'. | ||
frameRate | number | <optional> | null | The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used. |
loop | boolean | <optional> | false | Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used. |
killOnComplete | boolean | <optional> | false | If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed. |
A reference to playing Animation.
Automatically called by World.postUpdate. Handles cache updates.
Automatically called by World.preUpdate.
Removes a child from the container.
| Name | Type | Description |
|---|---|---|
child | DisplayObject | The DisplayObject to remove |
The child that was removed.
Removes a child from the specified index position.
| Name | Type | Description |
|---|---|---|
index | Number | The index to get the child from |
The child that was removed.
Removes all children from this container that are within the begin and end indexes.
| Name | Type | Description |
|---|---|---|
beginIndex | Number | The beginning position. Default value is 0. |
endIndex | Number | The ending position. Default value is size of the container. |
Renders the tiles to the layer canvas and pushes to the display.
Resets the Game Object.
This moves the Game Object to the given x/y world coordinates and sets fresh, exists,visible and renderable to true.
If this Game Object has the LifeSpan component it will also set alive to true and health to the given value.
If this Game Object has a Physics Body it will reset the Body.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
x | number | The x coordinate (in world space) to position the Game Object at. | ||
y | number | The y coordinate (in world space) to position the Game Object at. | ||
health | number | <optional> | 1 | The health to give the Game Object if it has the Health component. |
This instance.
Resets the texture frame dimensions that the Game Object uses for rendering.
The TilemapLayer caches tileset look-ups.
Call this method of clear the cache if tilesets have been added or updated after the layer has been rendered.
Resizes the internal canvas and texture frame used by this TilemapLayer.
This is an expensive call, so don't bind it to a window resize event! But instead call it at carefully
selected times.
Be aware that no validation of the new sizes takes place and the current map scroll coordinates are not
modified either. You will have to handle both of these things from your game code if required.
| Name | Type | Description |
|---|---|---|
width | number | The new width of the TilemapLayer |
height | number | The new height of the TilemapLayer |
Resizes the Frame dimensions that the Game Object uses for rendering.
You shouldn't normally need to ever call this, but in the case of special texture types such as Video or BitmapData
it can be useful to adjust the dimensions directly in this way.
| Name | Type | Description |
|---|---|---|
parent | object | The parent texture object that caused the resize, i.e. a Phaser.Video object. |
width | integer | The new width of the texture. |
height | integer | The new height of the texture. |
Sets the world size to match the size of this layer.
Brings a 'dead' Game Object back to life, optionally resetting its health value in the process.
A resurrected Game Object has its alive, exists and visible properties all set to true.
It will dispatch the onRevived event. Listen to events.onRevived for the signal.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
health | number | <optional> | 100 | The health to give the Game Object. Only set if the GameObject has the Health component. |
This instance.
Sends this Game Object to the bottom of its parents display list.
Visually this means it will render below all other children in the same Group.
If this Game Object hasn't been added to a custom Group then this method will send it to the bottom of the Game World,
because the World is the root Group from which all Game Objects descend.
This instance.
Changes the position of an existing child in the display object container
| Name | Type | Description |
|---|---|---|
child | DisplayObject | The child DisplayObject instance for which you want to change the index number |
index | Number | The resulting index number for the child display object |
Sets the texture frame the Game Object uses for rendering.
This is primarily an internal method used by loadTexture, but is exposed for the use of plugins and custom classes.
| Name | Type | Description |
|---|---|---|
frame | Phaser.Frame | The Frame to be used by the texture. |
This method will set the scale of the tilemap as well as update the underlying block data of this layer.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
xScale | number | <optional> | 1 | The scale factor along the X-plane |
yScale | number | <optional> | The scale factor along the Y-plane |
Sets the scaleMin and scaleMax values. These values are used to limit how far this Game Object will scale based on its parent.
For example if this Game Object has a minScale value of 1 and its parent has a scale value of 0.5, the 0.5 will be ignored
and the scale value of 1 will be used, as the parents scale is lower than the minimum scale this Game Object should adhere to.
By setting these values you can carefully control how Game Objects deal with responsive scaling.
If only one parameter is given then that value will be used for both scaleMin and scaleMax:setScaleMinMax(1) = scaleMin.x, scaleMin.y, scaleMax.x and scaleMax.y all = 1
If only two parameters are given the first is set as scaleMin.x and y and the second as scaleMax.x and y:setScaleMinMax(0.5, 2) = scaleMin.x and y = 0.5 and scaleMax.x and y = 2
If you wish to set scaleMin with different values for x and y then either modify Game Object.scaleMin directly,
or pass null for the maxX and maxY parameters.
Call setScaleMinMax(null) to clear all previously set values.
| Name | Type | Description |
|---|---|---|
minX | number | null | The minimum horizontal scale value this Game Object can scale down to. |
minY | number | null | The minimum vertical scale value this Game Object can scale down to. |
maxX | number | null | The maximum horizontal scale value this Game Object can scale up to. |
maxY | number | null | The maximum vertical scale value this Game Object can scale up to. |
Sets the texture of the sprite. Be warned that this doesn't remove or destroy the previous
texture this Sprite was using.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
texture | PIXI.Texture | The PIXI texture that is displayed by the sprite | ||
destroy | Boolean | <optional> | false | Call Texture.destroy on the current texture before replacing it with the new one? |
Swaps the position of 2 Display Objects within this container.
| Name | Type | Description |
|---|---|---|
child | DisplayObject | - |
child2 | DisplayObject | - |
Override this method in your own custom objects to handle any update requirements.
It is called immediately after preUpdate and before postUpdate.
Remember if this Game Object has any children you should call update on those too.
If you have set a crop rectangle on this Game Object via crop and since modified the cropRect property,
or the rectangle it references, then you need to update the crop frame by calling this method.
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.TilemapLayer.html