Class: Reset

Phaser.Component. Reset

new Reset()

The Reset component allows a Game Object to be reset and repositioned to a new location.

Source:
src/gameobjects/components/Reset.js line 12

Methods

reset(x, y [, health])

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.

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

Source:
src/gameobjects/components/Reset.js line 30
Returns:

This instance.

Type
PIXI.DisplayObject

phaser-ce@2.20.0 is on GitHub and NPM

Documentation generated by JSDoc 3.6.7 on 2022-12-10 using Tomorrow.