2013-10-25 15:54:40 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Source: gameobjects/GameObjectFactory.js< / title >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/sunlight.default.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/site.cerulean.css" >
< / head >
< body >
< div class = "container-fluid" >
< div class = "navbar navbar-fixed-top navbar-inverse" >
< div class = "navbar-inner" >
< a class = "brand" href = "index.html" > Phaser< / a >
< ul class = "nav" >
< li class = "dropdown" >
< a href = "namespaces.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Namespaces< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "Phaser.html" > Phaser< / a >
< / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "classes.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Classes< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
< li >
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
< / li >
< li >
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.BitmapFont.html" > BitmapFont< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
< li >
< a href = "Phaser.Button.html" > Button< / a >
< / li >
< li >
< a href = "Phaser.Cache.html" > Cache< / a >
< / li >
< li >
< a href = "Phaser.Camera.html" > Camera< / a >
< / li >
< li >
< a href = "Phaser.Canvas.html" > Canvas< / a >
< / li >
< li >
< a href = "Phaser.Circle.html" > Circle< / a >
< / li >
< li >
< a href = "Phaser.Color.html" > Color< / a >
< / li >
< li >
< a href = "Phaser.Device.html" > Device< / a >
< / li >
< li >
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
< li >
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
< li >
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
< li >
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
< li >
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
< li >
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
< li >
< a href = "Phaser.FrameData.html" > FrameData< / a >
< / li >
< li >
< a href = "Phaser.Game.html" > Game< / a >
< / li >
< li >
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
< li >
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
< li >
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-02-08 07:24:22 +00:00
< li >
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Input.html" > Input< / a >
< / li >
< li >
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
< li >
< a href = "Phaser.Key.html" > Key< / a >
< / li >
< li >
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
< li >
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
< li >
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
< / li >
< li >
< a href = "Phaser.Math.html" > Math< / a >
< / li >
< li >
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
< li >
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
< / li >
< li >
< a href = "Phaser.Net.html" > Net< / a >
< / li >
< li >
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
< li >
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
< li >
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
< li >
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
< li >
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
< li >
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
< li >
< a href = "Phaser.Point.html" > Point< / a >
< / li >
< li >
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
2013-11-07 06:10:15 +00:00
< li >
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
< li >
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
< li >
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
< li >
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
< li >
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
< li >
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
< li >
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.SpriteBatch.html" > SpriteBatch< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
< li >
< a href = "Phaser.StageScaleMode.html" > StageScaleMode< / a >
< / li >
< li >
< a href = "Phaser.State.html" > State< / a >
< / li >
< li >
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
< li >
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
< li >
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
< li >
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
< li >
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
< li >
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
< li >
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
< li >
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
< li >
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
< li >
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
< li >
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
< li >
< a href = "Phaser.World.html" > World< / a >
< / li >
< li >
< a href = "SignalBinding.html" > SignalBinding< / a >
< / li >
< / ul >
< / li >
2014-02-08 07:24:22 +00:00
< li class = "dropdown" >
< a href = "global.html" class = "dropdown-toggle" data-toggle = "dropdown" > Global< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "global.html#canUseNewCanvasBlendModes" > canUseNewCanvasBlendModes< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "global.html#getBounds" > getBounds< / a >
< / li >
2014-02-08 07:24:22 +00:00
< li >
< a href = "global.html#getNextPowerOfTwo" > getNextPowerOfTwo< / a >
< / li >
< li >
< a href = "global.html#hex2rgb" > hex2rgb< / a >
< / li >
< li >
< a href = "global.html#hitTest" > hitTest< / a >
< / li >
< li >
< a href = "global.html#rgb2hex" > rgb2hex< / a >
< / li >
< / ul >
< / li >
2013-10-25 15:54:40 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span12" >
< div id = "main" >
< h1 class = "page-title" > Source: gameobjects/GameObjectFactory.js< / h1 >
< section >
< article >
< pre class = "sunlight-highlight-javascript linenums" > /**
* @author Richard Davey < rich@photonstorm.com>
2014-02-05 06:29:17 +00:00
* @copyright 2014 Photon Storm Ltd.
2013-10-25 15:54:40 +00:00
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
2013-10-25 16:30:37 +00:00
* The Game Object Factory is a quick way to create all of the different sorts of core objects that Phaser uses.
2013-10-25 15:54:40 +00:00
*
* @class Phaser.GameObjectFactory
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
*/
Phaser.GameObjectFactory = function (game) {
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.Game} game - A reference to the currently running Game.
*/
this.game = game;
2013-10-25 15:54:40 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.World} world - A reference to the game world.
*/
this.world = this.game.world;
2013-10-25 15:54:40 +00:00
};
Phaser.GameObjectFactory.prototype = {
/**
2013-10-25 16:30:37 +00:00
* Adds an existing object to the game world.
* @method Phaser.GameObjectFactory#existing
2013-10-25 15:54:40 +00:00
* @param {*} object - An instance of Phaser.Sprite, Phaser.Button or any other display object..
* @return {*} The child that was added to the Group.
*/
existing: function (object) {
return this.world.add(object);
},
2013-11-28 15:57:09 +00:00
/**
2014-02-08 07:24:22 +00:00
* Create a new `Image` object. An Image is a light-weight object you can use to display anything that doesn't need physics or animation.
* It can still rotate, scale, crop and receive input events. This makes it perfect for logos, backgrounds, simple buttons and other non-Sprite graphics.
2013-10-25 15:54:40 +00:00
*
2014-02-08 07:24:22 +00:00
* @method Phaser.GameObjectFactory#image
* @param {number} x - X position of the image.
* @param {number} y - Y position of the image.
2013-10-25 15:54:40 +00:00
* @param {string|Phaser.RenderTexture|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param {string|number} [frame] - If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name.
2014-02-05 06:29:17 +00:00
* @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
2013-10-25 15:54:40 +00:00
* @returns {Phaser.Sprite} the newly created sprite object.
*/
2014-02-08 07:24:22 +00:00
image: function (x, y, key, frame, group) {
2013-10-25 15:54:40 +00:00
2014-02-05 06:29:17 +00:00
if (typeof group === 'undefined') { group = this.world; }
2014-02-08 07:24:22 +00:00
return group.add(new Phaser.Image(this.game, x, y, key, frame));
2013-10-25 15:54:40 +00:00
},
/**
2014-02-08 07:24:22 +00:00
* Create a new Sprite with specific position and sprite sheet key.
2013-10-25 15:54:40 +00:00
*
2014-02-08 07:24:22 +00:00
* @method Phaser.GameObjectFactory#sprite
2013-10-25 15:54:40 +00:00
* @param {number} x - X position of the new sprite.
* @param {number} y - Y position of the new sprite.
2014-02-08 07:24:22 +00:00
* @param {string|Phaser.RenderTexture|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param {string|number} [frame] - If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name.
* @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
2013-10-25 15:54:40 +00:00
* @returns {Phaser.Sprite} the newly created sprite object.
*/
2014-02-08 07:24:22 +00:00
sprite: function (x, y, key, frame, group) {
if (typeof group === 'undefined') { group = this.world; }
2013-10-25 15:54:40 +00:00
return group.create(x, y, key, frame);
},
/**
* Create a tween object for a specific object. The object can be any JavaScript object or Phaser object such as Sprite.
*
2013-10-25 16:30:37 +00:00
* @method Phaser.GameObjectFactory#tween
2013-10-25 15:54:40 +00:00
* @param {object} obj - Object the tween will be run on.
* @return {Phaser.Tween} Description.
*/
tween: function (obj) {
return this.game.tweens.create(obj);
},
/**
* A Group is a container for display objects that allows for fast pooling, recycling and collision checks.
*
2013-10-25 16:30:37 +00:00
* @method Phaser.GameObjectFactory#group
2014-02-05 06:29:17 +00:00
* @param {any} parent - The parent Group or DisplayObjectContainer that will hold this group, if any.
* @param {string} [name='group'] - A name for this Group. Not used internally but useful for debugging.
2014-02-18 03:01:51 +00:00
* @param {boolean} [addToStage=false] - If set to true this Group will be added directly to the Game.Stage instead of Game.World.
2013-10-25 15:54:40 +00:00
* @return {Phaser.Group} The newly created group.
*/
2014-02-18 03:01:51 +00:00
group: function (parent, name, addToStage) {
if (typeof name === 'undefined') { name = 'group'; }
if (typeof addToStage === 'undefined') { addToStage = false; }
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
return new Phaser.Group(this.game, parent, name, addToStage);
},
/**
* A Group is a container for display objects that allows for fast pooling, recycling and collision checks.
*
* @method Phaser.GameObjectFactory#spriteBatch
* @param {any} parent - The parent Group or DisplayObjectContainer that will hold this group, if any.
* @param {string} [name='group'] - A name for this Group. Not used internally but useful for debugging.
* @param {boolean} [addToStage=false] - If set to true this Group will be added directly to the Game.Stage instead of Game.World.
* @return {Phaser.Group} The newly created group.
*/
spriteBatch: function (parent, name, addToStage) {
if (typeof name === 'undefined') { name = 'group'; }
if (typeof addToStage === 'undefined') { addToStage = false; }
return new Phaser.SpriteBatch(this.game, parent, name, addToStage);
2013-10-25 15:54:40 +00:00
},
/**
2014-02-05 06:29:17 +00:00
* Creates a new Sound object.
2013-11-28 15:57:09 +00:00
*
2013-10-25 16:30:37 +00:00
* @method Phaser.GameObjectFactory#audio
2013-11-28 15:57:09 +00:00
* @param {string} key - The Game.cache key of the sound that this object will use.
* @param {number} [volume=1] - The volume at which the sound will be played.
* @param {boolean} [loop=false] - Whether or not the sound will loop.
* @param {boolean} [connect=true] - Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.
* @return {Phaser.Sound} The newly created text object.
*/
audio: function (key, volume, loop, connect) {
return this.game.sound.add(key, volume, loop, connect);
2013-10-25 15:54:40 +00:00
},
/**
2014-02-05 06:29:17 +00:00
* Creates a new Sound object.
*
* @method Phaser.GameObjectFactory#sound
* @param {string} key - The Game.cache key of the sound that this object will use.
* @param {number} [volume=1] - The volume at which the sound will be played.
* @param {boolean} [loop=false] - Whether or not the sound will loop.
* @param {boolean} [connect=true] - Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.
* @return {Phaser.Sound} The newly created text object.
*/
sound: function (key, volume, loop, connect) {
return this.game.sound.add(key, volume, loop, connect);
},
/**
* Creates a new TileSprite object.
2013-11-28 15:57:09 +00:00
*
2013-10-25 16:30:37 +00:00
* @method Phaser.GameObjectFactory#tileSprite
2014-02-18 03:01:51 +00:00
* @param {number} x - The x coordinate (in world space) to position the TileSprite at.
* @param {number} y - The y coordinate (in world space) to position the TileSprite at.
* @param {number} width - The width of the TileSprite.
* @param {number} height - The height of the TileSprite.
* @param {string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture} key - This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param {string|number} frame - If this TileSprite 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.
2014-02-05 06:29:17 +00:00
* @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
2013-11-28 15:57:09 +00:00
* @return {Phaser.TileSprite} The newly created tileSprite object.
*/
2014-02-18 03:01:51 +00:00
tileSprite: function (x, y, width, height, key, frame, group) {
2013-10-25 15:54:40 +00:00
2014-02-05 06:29:17 +00:00
if (typeof group === 'undefined') { group = this.world; }
2014-02-18 03:01:51 +00:00
return group.add(new Phaser.TileSprite(this.game, x, y, width, height, key, frame));
2013-10-25 15:54:40 +00:00
},
/**
2014-02-05 06:29:17 +00:00
* Creates a new Text object.
2013-11-28 15:57:09 +00:00
*
2013-10-25 16:30:37 +00:00
* @method Phaser.GameObjectFactory#text
2013-11-28 15:57:09 +00:00
* @param {number} x - X position of the new text object.
* @param {number} y - Y position of the new text object.
* @param {string} text - The actual text that will be written.
* @param {object} style - The style object containing style attributes like font, font size , etc.
2014-02-05 06:29:17 +00:00
* @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
2013-11-28 15:57:09 +00:00
* @return {Phaser.Text} The newly created text object.
*/
2014-02-05 06:29:17 +00:00
text: function (x, y, text, style, group) {
if (typeof group === 'undefined') { group = this.world; }
2013-10-25 15:54:40 +00:00
2014-02-05 06:29:17 +00:00
return group.add(new Phaser.Text(this.game, x, y, text, style));
2013-10-25 15:54:40 +00:00
},
/**
2014-02-05 06:29:17 +00:00
* Creates a new Button object.
2013-10-25 15:54:40 +00:00
*
2013-10-25 16:30:37 +00:00
* @method Phaser.GameObjectFactory#button
2013-10-25 15:54:40 +00:00
* @param {number} [x] X position of the new button object.
* @param {number} [y] Y position of the new button object.
* @param {string} [key] The image key as defined in the Game.Cache to use as the texture for this button.
* @param {function} [callback] The function to call when this button is pressed
* @param {object} [callbackContext] The context in which the callback will be called (usually 'this')
* @param {string|number} [overFrame] This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [outFrame] This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [downFrame] This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.
2014-02-05 06:29:17 +00:00
* @param {string|number} [upFrame] This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.
* @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
2013-10-25 15:54:40 +00:00
* @return {Phaser.Button} The newly created button object.
*/
2014-02-05 06:29:17 +00:00
button: function (x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame, group) {
2013-10-25 15:54:40 +00:00
2014-02-05 06:29:17 +00:00
if (typeof group === 'undefined') { group = this.world; }
return group.add(new Phaser.Button(this.game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame));
2013-10-25 15:54:40 +00:00
},
/**
2014-02-05 06:29:17 +00:00
* Creates a new Graphics object.
2013-11-28 15:57:09 +00:00
*
2013-10-25 16:30:37 +00:00
* @method Phaser.GameObjectFactory#graphics
2013-11-28 15:57:09 +00:00
* @param {number} x - X position of the new graphics object.
* @param {number} y - Y position of the new graphics object.
2014-02-05 06:29:17 +00:00
* @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
2013-11-28 15:57:09 +00:00
* @return {Phaser.Graphics} The newly created graphics object.
*/
2014-02-05 06:29:17 +00:00
graphics: function (x, y, group) {
if (typeof group === 'undefined') { group = this.world; }
2013-10-25 15:54:40 +00:00
2014-02-05 06:29:17 +00:00
return group.add(new Phaser.Graphics(this.game, x, y));
2013-10-25 15:54:40 +00:00
},
/**
* Emitter is a lightweight particle emitter. It can be used for one-time explosions or for
* continuous effects like rain and fire. All it really does is launch Particle objects out
* at set intervals, and fixes their positions and velocities accorindgly.
*
2013-10-25 16:30:37 +00:00
* @method Phaser.GameObjectFactory#emitter
2013-10-25 15:54:40 +00:00
* @param {number} [x=0] - The x coordinate within the Emitter that the particles are emitted from.
* @param {number} [y=0] - The y coordinate within the Emitter that the particles are emitted from.
* @param {number} [maxParticles=50] - The total number of particles in this emitter.
* @return {Phaser.Emitter} The newly created emitter object.
*/
emitter: function (x, y, maxParticles) {
return this.game.particles.add(new Phaser.Particles.Arcade.Emitter(this.game, x, y, maxParticles));
},
/**
2014-02-18 03:01:51 +00:00
* Create a new BitmapFont object to be used as a texture for an Image or Sprite and optionally add it to the Cache.
* The texture can be asssigned or one or multiple images/sprites, but note that the text the BitmapFont uses will be shared across them all,
* i.e. if you need each Image to have different text in it, then you need to create multiple BitmapFont objects.
*
* @method Phaser.GameObjectFactory#bitmapFont
* @param {string} font - The key of the image in the Game.Cache that the BitmapFont will use.
* @param {number} characterWidth - The width of each character in the font set.
* @param {number} characterHeight - The height of each character in the font set.
* @param {string} chars - The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.
* @param {number} charsPerRow - The number of characters per row in the font set.
* @param {number} [xSpacing=0] - If the characters in the font set have horizontal spacing between them set the required amount here.
* @param {number} [ySpacing=0] - If the characters in the font set have vertical spacing between them set the required amount here.
* @param {number} [xOffset=0] - If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.
* @param {number} [yOffset=0] - If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.
* @return {Phaser.BitmapFont} The newly created BitmapFont texture which can be applied to an Image or Sprite.
*/
bitmapFont: function (font, characterWidth, characterHeight, chars, charsPerRow, xSpacing, ySpacing, xOffset, yOffset) {
return new Phaser.BitmapFont(this.game, font, characterWidth, characterHeight, chars, charsPerRow, xSpacing, ySpacing, xOffset, yOffset);
},
/**
* Create a new BitmapText object.
2013-10-25 15:54:40 +00:00
*
2013-10-25 16:30:37 +00:00
* @method Phaser.GameObjectFactory#bitmapText
2013-10-25 15:54:40 +00:00
* @param {number} x - X position of the new bitmapText object.
* @param {number} y - Y position of the new bitmapText object.
2014-02-18 03:01:51 +00:00
* @param {string} font - The key of the BitmapText font as stored in Game.Cache.
* @param {string} [text] - The actual text that will be rendered. Can be set later via BitmapText.text.
* @param {number} [size] - The size the font will be rendered in, in pixels.
2014-02-05 06:29:17 +00:00
* @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
2013-10-25 15:54:40 +00:00
* @return {Phaser.BitmapText} The newly created bitmapText object.
*/
2014-02-18 03:01:51 +00:00
bitmapText: function (x, y, font, text, size, group) {
2014-02-05 06:29:17 +00:00
if (typeof group === 'undefined') { group = this.world; }
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
return group.add(new Phaser.BitmapText(this.game, x, y, font, text, size));
2013-10-25 15:54:40 +00:00
},
/**
2013-10-25 16:30:37 +00:00
* Creates a new Tilemap object.
2013-10-25 15:54:40 +00:00
*
2013-10-25 16:30:37 +00:00
* @method Phaser.GameObjectFactory#tilemap
2014-02-05 06:29:17 +00:00
* @param {string} key - Asset key for the JSON or CSV map data in the cache.
* @param {object|string} tilesets - An object mapping Cache.tileset keys with the tileset names in the JSON file. If a string is provided that will be used.
2013-10-25 15:54:40 +00:00
* @return {Phaser.Tilemap} The newly created tilemap object.
*/
2014-02-05 06:29:17 +00:00
tilemap: function (key, tilesets) {
2013-10-25 15:54:40 +00:00
2014-02-05 06:29:17 +00:00
return new Phaser.Tilemap(this.game, key, tilesets);
2013-10-25 15:54:40 +00:00
},
/**
2013-10-25 16:30:37 +00:00
* A dynamic initially blank canvas to which images can be drawn.
2013-10-25 15:54:40 +00:00
*
2013-10-25 16:30:37 +00:00
* @method Phaser.GameObjectFactory#renderTexture
2014-02-08 07:24:22 +00:00
* @param {number} [width=100] - the width of the RenderTexture.
* @param {number} [height=100] - the height of the RenderTexture.
* @param {string} [key=''] - Asset key for the RenderTexture when stored in the Cache (see addToCache parameter).
* @param {boolean} [addToCache=false] - Should this RenderTexture be added to the Game.Cache? If so you can retrieve it with Cache.getTexture(key)
* @return {Phaser.RenderTexture} The newly created RenderTexture object.
2013-10-25 15:54:40 +00:00
*/
2014-02-08 07:24:22 +00:00
renderTexture: function (width, height, key, addToCache) {
2013-10-25 15:54:40 +00:00
2014-02-08 07:24:22 +00:00
if (typeof key === 'undefined' || key === '') { key = this.game.rnd.uuid(); }
2014-02-18 03:01:51 +00:00
if (typeof addToCache === 'undefined') { addToCache = false; }
2013-10-25 15:54:40 +00:00
2014-02-08 07:24:22 +00:00
var texture = new Phaser.RenderTexture(this.game, width, height, key);
if (addToCache)
{
this.game.cache.addRenderTexture(key, texture);
}
2013-10-25 15:54:40 +00:00
return texture;
2013-11-28 15:57:09 +00:00
},
/**
2014-02-08 07:24:22 +00:00
* A BitmapData object which can be manipulated and drawn to like a traditional Canvas object and used to texture Sprites.
2013-11-28 15:57:09 +00:00
*
* @method Phaser.GameObjectFactory#bitmapData
2014-02-08 07:24:22 +00:00
* @param {number} [width=100] - The width of the BitmapData in pixels.
* @param {number} [height=100] - The height of the BitmapData in pixels.
* @param {string} [key=''] - Asset key for the BitmapData when stored in the Cache (see addToCache parameter).
* @param {boolean} [addToCache=false] - Should this BitmapData be added to the Game.Cache? If so you can retrieve it with Cache.getBitmapData(key)
2013-11-28 15:57:09 +00:00
* @return {Phaser.BitmapData} The newly created BitmapData object.
*/
2014-02-08 07:24:22 +00:00
bitmapData: function (width, height, addToCache) {
if (typeof addToCache === 'undefined') { addToCache = false; }
if (typeof key === 'undefined' || key === '') { key = this.game.rnd.uuid(); }
var texture = new Phaser.BitmapData(this.game, key, width, height);
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
if (addToCache)
{
this.game.cache.addBitmapData(key, texture);
}
return texture;
2013-11-28 15:57:09 +00:00
},
/**
* A WebGL shader/filter that can be applied to Sprites.
*
* @method Phaser.GameObjectFactory#filter
* @param {string} filter - The name of the filter you wish to create, for example HueRotate or SineWave.
* @param {any} - Whatever parameters are needed to be passed to the filter init function.
* @return {Phaser.Filter} The newly created Phaser.Filter object.
*/
filter: function (filter) {
var args = Array.prototype.splice.call(arguments, 1);
var filter = new Phaser.Filter[filter](this.game);
filter.init.apply(filter, args);
return filter;
2013-10-25 16:30:37 +00:00
}
2013-10-25 15:54:40 +00:00
2014-02-05 06:29:17 +00:00
};
Phaser.GameObjectFactory.prototype.constructor = Phaser.GameObjectFactory;
< / pre >
2013-10-25 15:54:40 +00:00
< / article >
< / section >
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-25 15:54:40 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-02-19 05:28:19 +00:00
on Wed Feb 19 2014 05:26:20 GMT-0000 (GMT) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-25 15:54:40 +00:00
< / span >
< / footer >
< / div >
< br clear = "both" >
< / div >
< / div >
< script src = "scripts/sunlight.js" > < / script >
< script src = "scripts/sunlight.javascript.js" > < / script >
< script src = "scripts/sunlight-plugin.doclinks.js" > < / script >
< script src = "scripts/sunlight-plugin.linenumbers.js" > < / script >
< script src = "scripts/sunlight-plugin.menu.js" > < / script >
< script src = "scripts/jquery.min.js" > < / script >
< script src = "scripts/jquery.scrollTo.js" > < / script >
< script src = "scripts/jquery.localScroll.js" > < / script >
< script src = "scripts/bootstrap-dropdown.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script > Sunlight . highlightAll ( { lineNumbers : true , showMenu : true , enableDoclinks : true } ) ; < / script >
< script >
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
< / script >
< / body >
< / html >
