Phaser API

PIXI. Strip

new Strip(texture, width, height)

Parameters:
Name Type Description
texture PIXI.Texture

The texture to use
width Number

the width
height Number

the height
Source - pixi/extras/Strip.js, line 5

Extends

Members

alpha :Number

The opacity of the object.

Inherited From:
Source - pixi/display/DisplayObject.js, line 65

blendMode :Number

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

Default Value:
  • PIXI.blendModes.NORMAL;
Source - pixi/extras/Strip.js, line 51

buttonMode :Boolean

This is used to indicate if the displayObject should display a mouse hand cursor on rollover

Inherited From:
Source - pixi/display/DisplayObject.js, line 90

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 - pixi/display/DisplayObject.js, line 436

<readonly> children :Array.<DisplayObject>

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

Type:
  • Array.<DisplayObject>
Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 17

defaultCursor :String

This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true

Inherited From:
Source - pixi/display/DisplayObject.js, line 143

dirty :Boolean

Whether the strip is dirty or not

Source - pixi/extras/Strip.js, line 43

filterArea :PIXI.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 - pixi/display/DisplayObject.js, line 180

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'

Type:
  • Array.<Filter>
Inherited From:
Source - pixi/display/DisplayObject.js, line 400

height :Number

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

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 63

hitArea :PIXI.Rectangle|PIXI.Circle|PIXI.Ellipse|PIXI.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:
Inherited From:
Source - pixi/display/DisplayObject.js, line 81

interactive :Boolean

Indicates if the sprite will have touch and mouse interactivity. It is false by default

Inherited From:
Default Value:
  • false
Source - pixi/display/DisplayObject.js, line 339

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 - pixi/display/DisplayObject.js, line 380

padding :Number

if you need a padding, not yet implemented

Source - pixi/extras/Strip.js, line 60

<readonly> parent :PIXI.DisplayObjectContainer

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 106

pivot :PIXI.Point

The pivot point of the displayObject that it rotates around

Inherited From:
Source - pixi/display/DisplayObject.js, line 49

position :PIXI.Point

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 14

renderable :Boolean

Can this object be rendered

Inherited From:
Source - pixi/display/DisplayObject.js, line 98

rotation :Number

The rotation of the object in radians.

Inherited From:
Source - pixi/display/DisplayObject.js, line 57

scale :PIXI.Point

The scale factor of the object.

Inherited From:
Source - pixi/display/DisplayObject.js, line 22

<readonly> stage :PIXI.Stage

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 115

texture :PIXI.Texture

The texture of the strip

Source - pixi/extras/Strip.js, line 20

transformCallback :function

The transform callback is an optional callback that if set will be called at the end of the updateTransform method and sent two parameters: This Display Objects worldTransform matrix and its parents transform matrix. Both are PIXI.Matrix object types. The matrix are passed by reference and can be modified directly without needing to return them. This ability allows you to check any of the matrix values and perform actions such as clamping scale or limiting rotation, regardless of the parent transforms.

Inherited From:
Source - pixi/display/DisplayObject.js, line 30

transformCallbackContext :Object

The context under which the transformCallback is invoked.

Inherited From:
Source - pixi/display/DisplayObject.js, line 41

visible :Boolean

The visibility of the object.

Inherited From:
Source - pixi/display/DisplayObject.js, line 73

width :Number

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

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 35

<readonly> worldAlpha :Number

[read-only] The multiplied alpha of the displayObject

Inherited From:
Source - pixi/display/DisplayObject.js, line 124

worldVisible :Boolean

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 359

x :Number

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 761

y :Number

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 776

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:
PIXI.DisplayObject -

The child that was added.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 90

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:
PIXI.DisplayObject -

The child that was added.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 102

click(interactionData)

A callback that is used when the users clicks on the displayObject with their mouse's left button

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 252

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:
PIXI.Texture -

a texture of the graphics object

Inherited From:
Source - pixi/display/DisplayObject.js, line 582

getBounds(matrix) → {PIXI.Rectangle}

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

Parameters:
Name Type Description
matrix PIXI.Matrix

the transformation matrix of the sprite
Returns:
PIXI.Rectangle -

the framing rectangle

Source - 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:
PIXI.DisplayObject -

The child at the given index, if any.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 193

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 - pixi/display/DisplayObjectContainer.js, line 158

getLocalBounds() → {PIXI.Rectangle}

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

Returns:
PIXI.Rectangle -

The rectangular bounding area

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 362

mousedown(interactionData)

A callback that is used when the user clicks the mouse's left button down over the sprite

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 258

mouseout(interactionData)

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

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 245

mouseover(interactionData)

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

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 239

mouseup(interactionData)

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

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 264

mouseupoutside(interactionData)

A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 271

removeChild(child) → {PIXI.DisplayObject}

Removes a child from the container.

Parameters:
Name Type Description
child PIXI.DisplayObject

The DisplayObject to remove
Returns:
PIXI.DisplayObject -

The child that was removed.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 210

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:
PIXI.DisplayObject -

The child that was removed.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 225

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 - pixi/display/DisplayObjectContainer.js, line 243

removeStageReference()

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

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 404

rightclick(interactionData)

A callback that is used when the users clicks on the displayObject with their mouse's right button

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 279

rightdown(interactionData)

A callback that is used when the user clicks the mouse's right button down over the sprite

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 285

rightup(interactionData)

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

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 291

rightupoutside(interactionData)

A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's right button must have been pressed down over the displayObject

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 298

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 - pixi/display/DisplayObjectContainer.js, line 175

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 PIXI.Stage

the stage that the container will have as its current stage reference
Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 386

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 - pixi/display/DisplayObjectContainer.js, line 133

tap(interactionData)

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

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 309

toGlobal(position) → {PIXI.Point}

Calculates the global position of the display object

Parameters:
Name Type Description
position PIXI.Point

The world origin to calculate from
Returns:
PIXI.Point -

A point object representing the position of this object

Inherited From:
Source - pixi/display/DisplayObject.js, line 616

toLocal(position, from) → {PIXI.Point}

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

Parameters:
Name Type Argument Description
position PIXI.Point

The world origin to calculate from
from PIXI.DisplayObject <optional>

The DisplayObject to calculate the global position from
Returns:
PIXI.Point -

A point object representing the position of this object

Inherited From:
Source - pixi/display/DisplayObject.js, line 630

touchend(interactionData)

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

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 322

touchendoutside(interactionData)

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 sprite

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 328

touchstart(interactionData)

A callback that is used when the user touches over the displayObject

Parameters:
Name Type Description
interactionData PIXI.InteractionData

-
Inherited From:
Source - pixi/display/DisplayObject.js, line 316

updateCache()

Generates and updates the cached sprite for this object.

Inherited From:
Source - pixi/display/DisplayObject.js, line 606
Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev on Tue Nov 25 2014 00:18:24 GMT-0000 (GMT) using the DocStrap template.