Documentation

Class: OverlaySpr

OverlaySpr

A Phaser Sprite extension to make game overlays and simple forms holes.

new OverlaySpr(game, x, y, width, height, path [, opt])

Create a sprite as overlay with an (optional) simple form hole.

Parameters:
Name Type Argument Default Description
game Phaser.Game

A Phaser Game instance.
x Number

x coordinate of the outer overlay's border.
y Number

y coordinate of the outer overlay's border.
width Number

Width of the outer overlay's border.
height Number

Height of the outer overlay's border.
path array false

Path to draw the hole. Hole should be an instance of any: Rectangle.Phaser, Circle.Phaser, Polygon.Phaser or none (if no hole is needed). Cordinates will be specified with absolute values (not relatives to overlay itself).
opt Object <optional>

An optional list of options.

Properties
Name Type Argument Default Description
bgColor Hex <optional>
 0xFFFFFF

Background color.
alpha Number <optional>
 0.5

Alpha value.
anticlockwise Boolean <optional>
 false

Drawing order for polygons. When drawing polygons, to do the hole trick nicely, you should specify if you are setting polygon points in anticlockwise order (clockwise is default).

Extends

Methods

$$centered( [anchor])

A shortcut for placing a sprite in the center of the screen

Parameters:
Name Type Argument Default Description
anchor Phaser.Point <optional>
 new Phaser.Point(0.5, 0.5)

the anchor point
Inherited From:

$$contains(point)

Checks if the sprites contains a point

Parameters:
Name Type Description
point Phaser.Point

the anchor point
Inherited From:

$$moveTo(destination [, anchor])

Moves the current object in the coordinates of another, considering groups/scaling

Parameters:
Name Type Argument Default Description
destination Phaser.Sprite | Phaser.Group

a destination object
anchor Phaser.Point <optional>
 new Phaser.Point(0.5, 0.5)

the anchor point
Inherited From:

$$pointIn(ancestor [, anchor])

Gets the cooordinates of the current object based on one of its ancestors

Parameters:
Name Type Argument Default Description
ancestor Phaser.Sprite | Phaser.Group

an ancestor of this object
anchor Phaser.Point <optional>
 new Phaser.Point(0.5, 0.5)

the anchor point
Inherited From:

$$tintTween(tint, duration [, options])

A shortcut for tint tween

Parameters:
Name Type Argument Default Description
tint Number

The tint value to tween to
duration Number

tween duration
options Object <optional>
 {}

Tween options

Properties
Name Type Argument Default Description
ease Object <optional>
 Phaser.Easing.Default

Default Ease function
autostart Object <optional>
 false
delay Object <optional>
 0
repeat Object <optional>
 0
yoyo Object <optional>
 false
Inherited From:

$$tween(properties, duration [, options])

A shortcut for tween creation in sprites

Parameters:
Name Type Argument Default Description
properties Object

properties to tween
duration Number

tween duration
options Object <optional>
 {}

Tween options

Properties
Name Type Argument Default Description
ease Object <optional>
 Phaser.Easing.Default

Default Ease function
autostart Object <optional>
 false
delay Object <optional>
 0
repeat Object <optional>
 0
yoyo Object <optional>
 false
Inherited From:
Overrides: