phaser/src/gameobjects/sprite/SpriteFactory.js

41 lines
1.5 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
2022-02-28 14:29:51 +00:00
* @copyright 2022 Photon Storm Ltd.
2019-05-10 15:15:04 +00:00
* @license {@link https://opensource.org/licenses/MIT|MIT License}
2018-02-12 16:01:20 +00:00
*/
var GameObjectFactory = require('../GameObjectFactory');
2018-02-06 14:13:30 +00:00
var Sprite = require('./Sprite');
2017-01-24 18:08:56 +00:00
2018-02-06 14:13:30 +00:00
/**
* Creates a new Sprite Game Object and adds it to the Scene.
*
* Note: This method will only be available if the Sprite Game Object has been built into Phaser.
*
* @method Phaser.GameObjects.GameObjectFactory#sprite
* @since 3.0.0
*
* @param {number} x - The horizontal position of this Game Object in the world.
* @param {number} y - The vertical position of this Game Object in the world.
2020-07-13 12:29:01 +00:00
* @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
2020-11-23 10:32:00 +00:00
* @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.
2018-03-20 14:56:31 +00:00
*
2018-02-06 14:13:30 +00:00
* @return {Phaser.GameObjects.Sprite} The Game Object that was created.
*/
GameObjectFactory.register('sprite', function (x, y, key, frame)
{
var sprite = new Sprite(this.scene, x, y, key, frame);
this.displayList.add(sprite);
2017-01-24 18:08:56 +00:00
return sprite;
});
2018-02-06 14:13:30 +00:00
// When registering a factory function 'this' refers to the GameObjectFactory context.
2018-03-20 14:56:31 +00:00
//
2018-02-06 14:13:30 +00:00
// There are several properties available to use:
2018-03-20 14:56:31 +00:00
//
2018-02-06 14:13:30 +00:00
// this.scene - a reference to the Scene that owns the GameObjectFactory
// this.displayList - a reference to the Display List the Scene owns
// this.updateList - a reference to the Update List the Scene owns