These docs are for an outdated version of Phaser The documentation on this page is for Phaser 2.4.4. The latest release is 2.9.2.

Constructor

Phaser. Rope

new Rope(game, x, y, key, frame, points)

A Rope is a Sprite that has a repeating texture.

The texture will automatically wrap on the edges as it moves.

Please note that Ropes cannot have an input handler.

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 Rope at.

y number

The y coordinate (in world space) to position the Rope at.

key string | Phaser.RenderTexture | Phaser.BitmapData | PIXI.Texture

This is the image or texture used by the Rope 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 Rope 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.

points Array

An array of {Phaser.Point}.

Source code: gameobjects/Rope.js (Line 42)

Extends

Public Properties

alive : boolean

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.

Inherited From
Default Value
  • true
Source code: gameobjects/components/LifeSpan.js (Line 50)

alpha : number

The opacity of the object.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 46)

angle : number

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.

Inherited From
Source code: gameobjects/components/Angle.js (Line 29)

animations : Phaser.AnimationManager

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.

Inherited From
Source code: gameobjects/components/Core.js (Line 186)
See

autoCull : boolean

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.

Inherited From
Source code: gameobjects/components/AutoCull.js (Line 28)

blendMode : number

The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.

Inherited From
Default Value
  • PIXI.blendModes.NORMAL;
Source code: pixi/extras/Strip.js (Line 51)

body : Phaser.Physics.Arcade.Body | Phaser.Physics.P2.Body | Phaser.Physics.Ninja.Body | null

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.

Type
Inherited From
Source code: gameobjects/components/PhysicsBody.js (Line 91)

[readonly] bottom : number

The sum of the y and height properties. This is the same as y + height - offsetY.

Inherited From
Source code: gameobjects/components/Bounds.js (Line 110)

cacheAsBitmap : boolean

Set if this display object is cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to 'null'

Inherited From
Source code: pixi/display/DisplayObject.js (Line 355)

cameraOffset : Phaser.Point

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.

Inherited From
Source code: gameobjects/components/FixedToCamera.js (Line 86)

canvasPadding : number

Triangles in canvas mode are automatically antialiased, use this value to force triangles to overlap a bit with each other.

Inherited From
Source code: pixi/extras/Strip.js (Line 60)

checkWorldBounds : boolean

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.

Inherited From
Source code: gameobjects/components/InWorld.js (Line 92)

[readonly] children : Array.<DisplayObject>

[read-only] The array of children of this container.

Type
Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 17)

<internal> components : Object

The components this Game Object has installed.

Inherited From
Internal:
  • This member is internal (protected) and may be modified or removed in the future.
Source code: gameobjects/components/Core.js (Line 160)

cropRect : Phaser.Rectangle

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.

Inherited From
Source code: gameobjects/components/Crop.js (Line 24)

debug : boolean

A debug flag designed for use with Game.enableStep.

Inherited From
Source code: gameobjects/components/Core.js (Line 211)

[readonly] deltaX : number

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.

Inherited From
Source code: gameobjects/components/Delta.js (Line 24)

[readonly] deltaY : number

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.

Inherited From
Source code: gameobjects/components/Delta.js (Line 42)

[readonly] deltaZ : number

Returns the delta z value. The difference between rotation now and in the previous frame. The delta value.

Inherited From
Source code: gameobjects/components/Delta.js (Line 58)

[readonly] destroyPhase : boolean

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.

Inherited From
Source code: gameobjects/components/Destroy.js (Line 22)

dirty : boolean

Whether the strip is dirty or not

Inherited From
Source code: pixi/extras/Strip.js (Line 43)

events : Phaser.Events

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.

Inherited From
Source code: gameobjects/components/Core.js (Line 178)
See

exists : boolean

Controls if this Game Object is processed by the core game loop. If this Game Object has a physics body it also controls if its physics body is updated or not. When exists is set to false it will remove its physics body from the physics world if it has one. It also toggles the visible property to false as well.

Setting exists to true will add its physics body back in to the physics world, if it has one. It will also set the visible property to true.

Inherited From
Source code: gameobjects/components/Core.js (Line 277)

filterArea :Rectangle

The area the filter is applied to like the hitArea this is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Inherited From
Source code: pixi/display/DisplayObject.js (Line 164)

filters : Array.<Filter>

Sets the filters for the displayObject. IMPORTANT: This is a webGL only feature and will be ignored by the Canvas renderer.

To remove filters simply set this property to 'null'.

You cannot have a filter and a multiply blend mode active at the same time. Setting a filter will reset this objects blend mode to NORMAL.

Type
  • Array.<Filter>
Inherited From
Source code: pixi/display/DisplayObject.js (Line 307)

fixedToCamera : boolean

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.

Inherited From
Source code: gameobjects/components/FixedToCamera.js (Line 56)

frame : integer

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.

Inherited From
Source code: gameobjects/components/LoadTexture.js (Line 218)

frameName : string

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.

Inherited From
Source code: gameobjects/components/LoadTexture.js (Line 243)

[readonly] fresh : boolean

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.

Inherited From
Source code: gameobjects/components/Core.js (Line 241)

game : Phaser.Game

A reference to the currently running Game.

Inherited From
Source code: gameobjects/components/Core.js (Line 145)

height : number

The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 61)

hitArea :Rectangle | Circle | Ellipse | Polygon

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)

Type
  • Rectangle | Circle | Ellipse | Polygon
Inherited From
Source code: pixi/display/DisplayObject.js (Line 62)

[readonly] inCamera : boolean

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.

Inherited From
Source code: gameobjects/components/AutoCull.js (Line 37)

[readonly] inWorld : boolean

Checks if the Game Objects bounds are within, or intersect at any point with the Game World bounds.

Inherited From
Source code: gameobjects/components/InWorld.js (Line 114)

key : string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture

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.

Type
Inherited From
Source code: gameobjects/components/Core.js (Line 196)

[readonly] left : number

The left coordinate of the Game Object. This is the same as x - offsetX.

Inherited From
Source code: gameobjects/components/Bounds.js (Line 59)

lifespan : number

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.

Inherited From
Source code: gameobjects/components/LifeSpan.js (Line 65)

mask : PIXI.Graphics

Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 282)

name : string

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.

Inherited From
Source code: gameobjects/components/Core.js (Line 153)

[readonly] offsetX : number

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.

Inherited From
Source code: gameobjects/components/Bounds.js (Line 24)

[readonly] offsetY : number

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.

Inherited From
Source code: gameobjects/components/Bounds.js (Line 42)

outOfBoundsKill : boolean

If this and the checkWorldBounds property are both set to true then the kill method is called as soon as inWorld returns false.

Inherited From
Source code: gameobjects/components/InWorld.js (Line 100)

[readonly] parent : PIXI.DisplayObjectContainer

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

Inherited From
Source code: pixi/display/DisplayObject.js (Line 79)

pendingDestroy : boolean

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.

Inherited From
Source code: gameobjects/components/Core.js (Line 252)

pivot :Point

The pivot point of the displayObject that it rotates around

Inherited From
Source code: pixi/display/DisplayObject.js (Line 30)

position :Point

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

Inherited From
Source code: pixi/display/DisplayObject.js (Line 14)

[readonly] previousPosition : Phaser.Point

The position the Game Object was located in the previous frame.

Inherited From
Source code: gameobjects/components/Core.js (Line 218)

[readonly] previousRotation : number

The rotation the Game Object was in set to in the previous frame. Value is in radians.

Inherited From
Source code: gameobjects/components/Core.js (Line 225)

renderable : boolean

Can this object be rendered

Inherited From
Source code: pixi/display/DisplayObject.js (Line 71)

[readonly] renderOrderID : number

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.

Inherited From
Source code: gameobjects/components/Core.js (Line 233)

The right coordinate of the Game Object. This is the same as x + width - offsetX.

Inherited From
Source code: gameobjects/components/Bounds.js (Line 76)

rotation : number

The rotation of the object in radians.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 38)

scale :Point

The scale factor of the object.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 22)

scaleMax : Phaser.Point

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.

Inherited From
Source code: gameobjects/components/ScaleMinMax.js (Line 46)

scaleMin : Phaser.Point

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.

Inherited From
Source code: gameobjects/components/ScaleMinMax.js (Line 36)

segments

The segments that make up the rope body as an array of Phaser.Rectangles

Properties:
Name Type Description
updateAnimation Array.<Phaser.Rectangles>

Returns an array of Phaser.Rectangles that represent the segments of the given rope

Source code: gameobjects/Rope.js (Line 175)

smoothed : boolean

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.

Inherited From
Source code: gameobjects/components/Smoothed.js (Line 25)

[readonly] stage :Stage

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

Inherited From
Source code: pixi/display/DisplayObject.js (Line 88)

texture : PIXI.Texture

The texture of the strip

Inherited From
Source code: pixi/extras/Strip.js (Line 20)

[readonly] top : number

The y coordinate of the Game Object. This is the same as y - offsetY.

Inherited From
Source code: gameobjects/components/Bounds.js (Line 93)

transformCallback : Function

The callback that will apply any scale limiting to the worldTransform.

Inherited From
Source code: gameobjects/components/ScaleMinMax.js (Line 20)

transformCallbackContext : Object

The context under which transformCallback is called.

Inherited From
Source code: gameobjects/components/ScaleMinMax.js (Line 26)

[readonly] type : number

The const type of this object.

Source code: gameobjects/Rope.js (Line 57)

updateAnimation : Function

A Rope will call its updateAnimation function on each update loop if it has one. Set to a function if you'd like the rope to animate during the update phase. Set to false or null to remove it.

Source code: gameobjects/Rope.js (Line 144)

visible : boolean

The visibility of the object.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 54)

width : number

The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 32)

world : Phaser.Point

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.

Inherited From
Source code: gameobjects/components/Core.js (Line 204)

[readonly] worldAlpha : number

[read-only] The multiplied alpha of the displayObject

Inherited From
Source code: pixi/display/DisplayObject.js (Line 97)

[readonly] worldPosition :Point

The position of the Display Object based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 116)

[readonly] worldRotation : number

The rotation of the Display Object, in radians, based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 136)

[readonly] worldScale :Point

The scale of the Display Object based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 126)

worldVisible : boolean

[read-only] Indicates if the sprite is globally visible.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 258)

x : number

The position of the displayObject on the x axis relative to the local coordinates of the parent.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 719)

y : number

The position of the displayObject on the y axis relative to the local coordinates of the parent.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 737)

[readonly] z : number

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.

Inherited From
Source code: gameobjects/components/Core.js (Line 170)

Public Methods

addChild(child) → {PIXI.DisplayObject}

Adds a child to the container.

Parameters
Name Type Description
child PIXI.DisplayObject

The DisplayObject to add to the container

Returns

The child that was added.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 91)

addChildAt(child, index) → {PIXI.DisplayObject}

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

Parameters
Name Type Description
child PIXI.DisplayObject

The child to add

index Number

The index to place the child in

Returns

The child that was added.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 103)

bringToTop() → {PIXI.DisplayObject}

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.

Returns

This instance.

Inherited From
Source code: gameobjects/components/BringToTop.js (Line 24)

crop(rect, copy)

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.

Parameters
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 cropRect will be stored as a reference to the given rect. If true it will copy the rect values into a local Phaser Rectangle object stored in cropRect.

Inherited From
Source code: gameobjects/components/Crop.js (Line 49)

destroy()

Destroy this DisplayObject. Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 223)

generateTexture(resolution, scaleMode, renderer) → {PIXI.Texture}

Useful function that returns a texture of the displayObject object that can then be used to create sprites This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.

Parameters
Name Type Description
resolution Number

The resolution of the texture being generated

scaleMode Number

See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

renderer PIXI.CanvasRenderer | PIXI.WebGLRenderer

The renderer used to generate the texture.

Returns

a texture of the graphics object

Inherited From
Source code: pixi/display/DisplayObject.js (Line 542)

getBounds(matrix) → {Rectangle}

Returns the bounds of the mesh as a rectangle. The bounds calculation takes the worldTransform into account.

Parameters
Name Type Description
matrix Matrix

the transformation matrix of the sprite

Returns
Rectangle -

the framing rectangle

Inherited From
Source code: pixi/extras/Strip.js (Line 402)

getChildAt(index) → {PIXI.DisplayObject}

Returns the child at the specified index

Parameters
Name Type Description
index Number

The index to get the child from

Returns

The child at the given index, if any.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 194)

getChildIndex(child) → {Number}

Returns the index position of a child DisplayObject instance

Parameters
Name Type Description
child PIXI.DisplayObject

The DisplayObject instance to identify

Returns
Number -

The index position of the child display object to identify

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 159)

getLocalBounds() → {Rectangle}

Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.

Returns
Rectangle -

The rectangular bounding area

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 367)

kill() → {PIXI.DisplayObject}

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.

Returns

This instance.

Inherited From
Source code: gameobjects/components/LifeSpan.js (Line 113)

loadTexture(key, frame, stopAnimation)

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.

Parameters
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.

Inherited From
Source code: gameobjects/components/LoadTexture.js (Line 42)

moveDown() → {PIXI.DisplayObject}

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.

Returns

This instance.

Inherited From
Source code: gameobjects/components/BringToTop.js (Line 87)

moveUp() → {PIXI.DisplayObject}

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.

Returns

This instance.

Inherited From
Source code: gameobjects/components/BringToTop.js (Line 66)

overlap(displayObject) → {boolean}

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.

Parameters
Name Type Description
displayObject Phaser.Sprite | Phaser.Image | Phaser.TileSprite | Phaser.Button | PIXI.DisplayObject

The display object to check against.

Returns
boolean -

True if the bounds of this Game Object intersects at any point with the bounds of the given display object.

Inherited From
Source code: gameobjects/components/Overlap.js (Line 29)

play(name, frameRate, loop, killOnComplete) → {Phaser.Animation}

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.

Parameters
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.

Returns

A reference to playing Animation.

Inherited From
Source code: gameobjects/components/Animation.js (Line 31)

<internal> postUpdate()

Internal method called by the World postUpdate cycle.

Inherited From
Internal:
  • This member is internal (protected) and may be modified or removed in the future.
Source code: gameobjects/components/Core.js (Line 331)

preUpdate()

Automatically called by World.preUpdate.

Source code: gameobjects/Rope.js (Line 93)

removeChild(child) → {PIXI.DisplayObject}

Removes a child from the container.

Parameters
Name Type Description
child PIXI.DisplayObject

The DisplayObject to remove

Returns

The child that was removed.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 211)

removeChildAt(index) → {PIXI.DisplayObject}

Removes a child from the specified index position.

Parameters
Name Type Description
index Number

The index to get the child from

Returns

The child that was removed.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 226)

removeChildren(beginIndex, endIndex)

Removes all children from this container that are within the begin and end indexes.

Parameters
Name Type Description
beginIndex Number

The beginning position. Default value is 0.

endIndex Number

The ending position. Default value is size of the container.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 244)

removeStageReference()

Removes the current stage reference from the container and all of its children.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 407)

reset(x, y)

Resets the Rope. This places the Rope at the given x/y world coordinates and then sets alive, exists, visible and renderable all to true. Also resets the outOfBounds state. If the Rope has a physics body that too is reset.

Parameters
Name Type Description
x number

The x coordinate (in world space) to position the Sprite at.

y number

The y coordinate (in world space) to position the Sprite at.

Returns

(Phaser.Rope) This instance.

Source code: gameobjects/Rope.js (Line 125)

resetFrame()

Resets the texture frame dimensions that the Game Object uses for rendering.

Inherited From
Source code: gameobjects/components/LoadTexture.js (Line 196)

resizeFrame(parent, width, height)

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.

Parameters
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.

Inherited From
Source code: gameobjects/components/LoadTexture.js (Line 184)

revive(health) → {PIXI.DisplayObject}

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.

Parameters
Name Type Argument Default Description
health number <optional>
1

The health to give the Game Object. Only set if the GameObject has the Health component.

Returns

This instance.

Inherited From
Source code: gameobjects/components/LifeSpan.js (Line 78)

sendToBack() → {PIXI.DisplayObject}

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.

Returns

This instance.

Inherited From
Source code: gameobjects/components/BringToTop.js (Line 45)

setChildIndex(child, index)

Changes the position of an existing child in the display object container

Parameters
Name Type Description
child PIXI.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

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 176)

setFrame(frame)

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.

Parameters
Name Type Description
frame Phaser.Frame

The Frame to be used by the texture.

Inherited From
Source code: gameobjects/components/LoadTexture.js (Line 119)

setScaleMinMax(minX, minY, maxX, maxY)

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.

Parameters
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.

Inherited From
Source code: gameobjects/components/ScaleMinMax.js (Line 110)

setStageReference(stage)

Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.

Parameters
Name Type Description
stage Stage

the stage that the container will have as its current stage reference

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 391)

swapChildren(child, child2)

Swaps the position of 2 Display Objects within this container.

Parameters
Name Type Description
child PIXI.DisplayObject

-

child2 PIXI.DisplayObject

-

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 134)

toGlobal(position) → {Point}

Calculates the global position of the display object

Parameters
Name Type Description
position Point

The world origin to calculate from

Returns
Point -

A point object representing the position of this object

Inherited From
Source code: pixi/display/DisplayObject.js (Line 576)

toLocal(position, from) → {Point}

Calculates the local position of the display object relative to another point

Parameters
Name Type Argument Description
position Point

The world origin to calculate from

from PIXI.DisplayObject <optional>

The DisplayObject to calculate the global position from

Returns
Point -

A point object representing the position of this object

Inherited From
Source code: pixi/display/DisplayObject.js (Line 590)

update()

Override and use this function in your own custom objects to handle any update requirements you may have.

Source code: gameobjects/Rope.js (Line 110)

updateCache()

Generates and updates the cached sprite for this object.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 566)

updateCrop()

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.

Inherited From
Source code: gameobjects/components/Crop.js (Line 86)