new TileSprite(game, x, y, width, height, key, frame)
A TileSprite is a Sprite that has a repeating texture. The texture can be scrolled and scaled and will automatically wrap on the edges as it does so. Please note that TileSprites, as with normal Sprites, have no input handler or physics bodies by default. Both need enabling.
Parameters:
| Name | Type | Description |
|---|---|---|
game |
Phaser.Game | A reference to the currently running game. |
x |
number | The x coordinate (in world space) to position the TileSprite at. |
y |
number | The y coordinate (in world space) to position the TileSprite at. |
width |
number | The width of the TileSprite. |
height |
number | The height of the TileSprite. |
key |
string | Phaser.RenderTexture | Phaser.BitmapData | PIXI.Texture | This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture. |
frame |
string | number | If this TileSprite 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. |
- Source:
Extends
- PIXI.TilingSprite
Members
-
alive
-
- Default Value:
- true
- Source:
Properties:
Name Type Description aliveboolean A useful boolean to control if the TileSprite is alive or dead (in terms of your gameplay, it doesn't effect rendering).
-
angle
-
Indicates the rotation of the Sprite, 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 use the property Sprite.rotation instead. Working in radians is also a little faster as it doesn't have to convert the angle.
- Source:
Properties:
Name Type Description anglenumber The angle of this Sprite in degrees.
-
animations
-
- Source:
Properties:
Name Type Description animationsPhaser.AnimationManager This manages animations of the sprite. You can modify animations through it (see Phaser.AnimationManager)
-
autoCull
-
Should this Sprite be automatically culled if out of range of the camera? A culled sprite has its renderable property set to 'false'. Be advised this is quite an expensive operation, as it has to calculate the bounds of the object every frame, so only enable it if you really need it.
- Default Value:
- false
- Source:
Properties:
Name Type Description autoCullboolean A flag indicating if the Sprite should be automatically camera culled or not.
-
body
-
By default Sprites won't add themselves to any physics system and their physics body will be
null. To enable them for physics you need to callgame.physics.enable(sprite, system)wherespriteis this object andsystemis the Physics system you want to use to manage this body. Once enabled you can access all physics related properties viaSprite.body.Important: Enabling a Sprite for P2 or Ninja physics will automatically set
Sprite.anchorto 0.5 so the physics body is centered on the Sprite. If you need a different result then adjust or re-create the Body shape offsets manually, and/or reset the anchor after enabling physics.- Default Value:
- null
- Source:
Properties:
Name Type Description bodyPhaser.Physics.Arcade.Body | Phaser.Physics.P2.Body | Phaser.Physics.Ninja.Body | null -
cameraOffset
-
- Source:
Properties:
Name Type Description cameraOffsetPhaser.Point If this object is fixedToCamera then this stores the x/y offset that its drawn at, from the top-left of the camera view.
-
checkWorldBounds
-
If true the Sprite checks if it is still within the world each frame, when it leaves the world it dispatches Sprite.events.onOutOfBounds and optionally kills the sprite (if Sprite.outOfBoundsKill is true). By default this is disabled because the Sprite has to calculate its bounds every frame to support it, and not all games need it. Enable it by setting the value to true.
- Default Value:
- false
- Source:
Properties:
Name Type Description checkWorldBoundsboolean -
destroyPhase
-
- Source:
Properties:
Name Type Description destroyPhaseboolean True if this object is currently being destroyed.
-
events
-
- Source:
Properties:
Name Type Description eventsPhaser.Events The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.
-
exists
-
TileSprite.exists controls if the core game loop and physics update this TileSprite or not. When you set TileSprite.exists to false it will remove its Body from the physics world (if it has one) and also set TileSprite.visible to false. Setting TileSprite.exists to true will re-add the Body to the physics world (if it has a body) and set TileSprite.visible to true.
- Source:
Properties:
Name Type Description existsboolean If the TileSprite is processed by the core game update and physics.
-
fixedToCamera
-
An TileSprite that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera. These are stored in TileSprite.cameraOffset. Note that the cameraOffset values are in addition to any parent in the display list. So if this TileSprite was in a Group that has x: 200, then this will be added to the cameraOffset.x
- Source:
Properties:
Name Type Description fixedToCameraboolean Set to true to fix this TileSprite to the Camera at its current world coordinates.
-
frame
-
- Source:
Properties:
Name Type Description framenumber Gets or sets the current frame index and updates the Texture Cache for display.
-
frameName
-
- Source:
Properties:
Name Type Description frameNamestring Gets or sets the current frame name and updates the Texture Cache for display.
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game A reference to the currently running Game.
-
input
-
- Source:
Properties:
Name Type Description inputPhaser.InputHandler | null The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.
-
inputEnabled
-
By default a TileSprite won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is activated for this object and it will then start to process click/touch events and more.
- Source:
Properties:
Name Type Description inputEnabledboolean Set to true to allow this object to receive input events.
-
key
-
- Source:
Properties:
Name Type Description keystring | Phaser.RenderTexture | Phaser.BitmapData | 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 entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
-
name
-
- Source:
Properties:
Name Type Description namestring The user defined name given to this Sprite.
-
<readonly> type
-
- Source:
Properties:
Name Type Description typenumber The const type of this object.
-
world
-
- Source:
Properties:
Name Type Description worldPhaser.Point The world coordinates of this Sprite. This differs from the x/y coordinates which are relative to the Sprites container.
-
x
-
The position of the TileSprite on the x axis relative to the local coordinates of the parent.
- Source:
Properties:
Name Type Description xnumber The position of the TileSprite on the x axis relative to the local coordinates of the parent.
-
y
-
The position of the TileSprite on the y axis relative to the local coordinates of the parent.
- Source:
Properties:
Name Type Description ynumber The position of the TileSprite on the y axis relative to the local coordinates of the parent.
-
z
-
- Source:
Properties:
Name Type Description znumber The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.
Methods
-
autoScroll(x, y)
-
Sets this TileSprite to automatically scroll in the given direction until stopped via TileSprite.stopScroll(). The scroll speed is specified in pixels per second. A negative x value will scroll to the left. A positive x value will scroll to the right. A negative y value will scroll up. A positive y value will scroll down.
Parameters:
Name Type Description xnumber Horizontal scroll speed in pixels per second.
ynumber Vertical scroll speed in pixels per second.
- Source:
-
destroy(destroyChildren)
-
Destroys the TileSprite. This removes it from its parent group, destroys the event and animation handlers if present and nulls its reference to game, freeing it up for garbage collection.
Parameters:
Name Type Argument Default Description destroyChildrenboolean <optional>
true Should every child of this object have its destroy method called?
- Source:
-
loadTexture(key, frame)
-
Changes the Texture the TileSprite is using entirely. The old texture is removed and the new one is referenced or fetched from the Cache. This causes a WebGL texture update, so use sparingly or in low-intensity portions of your game.
Parameters:
Name Type Description keystring | Phaser.RenderTexture | Phaser.BitmapData | PIXI.Texture This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
framestring | number If this TileSprite 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.
- Source:
-
play(name, frameRate, loop, killOnComplete) → {Phaser.Animation}
-
Play an animation based on the given key. The animation should previously have been added via sprite.animations.add() If the requested animation is already playing this request will be ignored. If you need to reset an already running animation do so directly on the Animation object itself.
Parameters:
Name Type Argument Default Description namestring The name of the animation to be played, e.g. "fire", "walk", "jump".
frameRatenumber <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.
loopboolean <optional>
false Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.
killOnCompleteboolean <optional>
false If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.
- Source:
Returns:
A reference to playing Animation instance.
- Type
- Phaser.Animation
-
postUpdate()
-
Internal function called by the World postUpdate cycle.
- Source:
-
preUpdate()
-
Automatically called by World.preUpdate.
- Source:
-
reset(x, y)
-
Resets the TileSprite. This places the TileSprite at the given x/y world coordinates, resets the tilePosition and then sets alive, exists, visible and renderable all to true. Also resets the outOfBounds state. If the TileSprite has a physics body that too is reset.
Parameters:
Name Type Description xnumber The x coordinate (in world space) to position the Sprite at.
ynumber The y coordinate (in world space) to position the Sprite at.
- Source:
Returns:
(Phaser.TileSprite) This instance.
-
setFrame(frame)
-
Sets the Texture frame the TileSprite uses for rendering. This is primarily an internal method used by TileSprite.loadTexture, although you may call it directly.
Parameters:
Name Type Description framePhaser.Frame The Frame to be used by the TileSprite texture.
- Source:
-
stopScroll()
-
Stops an automatically scrolling TileSprite.
- Source:
-
update()
-
Override and use this function in your own custom objects to handle any update requirements you may have.
- Source: