Phaser Class: GameObjectFactory

new GameObjectFactory(game)

The Game Object Factory is a quick way to create all of the different sorts of core objects that Phaser uses.

Parameters:

Name	Type	Description
`game`	Phaser.Game	A reference to the currently running game.

Source:

gameobjects/GameObjectFactory.js, line 14

Members

game

Properties:

Name	Type	Description
`game`	Phaser.Game	A reference to the currently running Game.

Source:

gameobjects/GameObjectFactory.js, line 19

world

Properties:

Name	Type	Description
`world`	Phaser.World	A reference to the game world.

Source:

gameobjects/GameObjectFactory.js, line 24

Methods

audio(key, volume, loop, connect) → {Phaser.Sound}

Creates a new Sound object.

Parameters:

Name	Type	Argument	Default	Description
`key`	string			The Game.cache key of the sound that this object will use.
`volume`	number	<optional>	1	The volume at which the sound will be played.
`loop`	boolean	<optional>	false	Whether or not the sound will loop.
`connect`	boolean	<optional>	true	Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.

Source:

gameobjects/GameObjectFactory.js, line 130

Returns:

The newly created text object.

Type: Phaser.Sound

bitmapData(width, height, key, addToCache) → {Phaser.BitmapData}

A BitmapData object which can be manipulated and drawn to like a traditional Canvas object and used to texture Sprites.

Parameters:

Name	Type	Argument	Default	Description
`width`	number	<optional>	100	The width of the BitmapData in pixels.
`height`	number	<optional>	100	The height of the BitmapData in pixels.
`key`	string	<optional>	''	Asset key for the BitmapData when stored in the Cache (see addToCache parameter).
`addToCache`	boolean	<optional>	false	Should this BitmapData be added to the Game.Cache? If so you can retrieve it with Cache.getBitmapData(key)

Source:

gameobjects/GameObjectFactory.js, line 343

Returns:

The newly created BitmapData object.

Type: Phaser.BitmapData

bitmapFont(font, characterWidth, characterHeight, chars, charsPerRow, xSpacing, ySpacing, xOffset, yOffset) → {Phaser.BitmapFont}

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.

Parameters:

Name	Type	Argument	Default	Description
`font`	string			The key of the image in the Game.Cache that the BitmapFont will use.
`characterWidth`	number			The width of each character in the font set.
`characterHeight`	number			The height of each character in the font set.
`chars`	string			The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.
`charsPerRow`	number			The number of characters per row in the font set.
`xSpacing`	number	<optional>	0	If the characters in the font set have horizontal spacing between them set the required amount here.
`ySpacing`	number	<optional>	0	If the characters in the font set have vertical spacing between them set the required amount here.
`xOffset`	number	<optional>	0	If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.
`yOffset`	number	<optional>	0	If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.

Source:

gameobjects/GameObjectFactory.js, line 260

Returns:

The newly created BitmapFont texture which can be applied to an Image or Sprite.

Type: Phaser.BitmapFont

bitmapText(x, y, font, text, size, group) → {Phaser.BitmapText}

Create a new BitmapText object.

Parameters:

Name	Type	Argument	Description
`x`	number		X position of the new bitmapText object.
`y`	number		Y position of the new bitmapText object.
`font`	string		The key of the BitmapText font as stored in Game.Cache.
`text`	string	<optional>	The actual text that will be rendered. Can be set later via BitmapText.text.
`size`	number	<optional>	The size the font will be rendered in, in pixels.
`group`	Phaser.Group	<optional>	Optional Group to add the object to. If not specified it will be added to the World group.

Source:

gameobjects/GameObjectFactory.js, line 283

Returns:

The newly created bitmapText object.

Type: Phaser.BitmapText

button(x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame, group) → {Phaser.Button}

Creates a new Button object.

Parameters:

Name	Type	Argument	Description
`x`	number	<optional>	X position of the new button object.
`y`	number	<optional>	Y position of the new button object.
`key`	string	<optional>	The image key as defined in the Game.Cache to use as the texture for this button.
`callback`	function	<optional>	The function to call when this button is pressed
`callbackContext`	object	<optional>	The context in which the callback will be called (usually 'this')
`overFrame`	string \| number	<optional>	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.
`outFrame`	string \| number	<optional>	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.
`downFrame`	string \| number	<optional>	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.
`upFrame`	string \| number	<optional>	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.
`group`	Phaser.Group	<optional>	Optional Group to add the object to. If not specified it will be added to the World group.

Source:

gameobjects/GameObjectFactory.js, line 202

Returns:

The newly created button object.

Type: Phaser.Button

emitter(x, y, maxParticles) → {Phaser.Emitter}

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.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The x coordinate within the Emitter that the particles are emitted from.
`y`	number	<optional>	0	The y coordinate within the Emitter that the particles are emitted from.
`maxParticles`	number	<optional>	50	The total number of particles in this emitter.

Source:

gameobjects/GameObjectFactory.js, line 243

Returns:

The newly created emitter object.

Type: Phaser.Emitter

existing(object) → {*}

Adds an existing object to the game world.

Parameters:

Name	Type	Description
`object`	*	An instance of Phaser.Sprite, Phaser.Button or any other display object..

Source:

gameobjects/GameObjectFactory.js, line 30

Returns:

The child that was added to the Group.

Type: *

filter(filter) → {Phaser.Filter}

A WebGL shader/filter that can be applied to Sprites.

Parameters:

Name	Type	Description
`filter`	string	The name of the filter you wish to create, for example HueRotate or SineWave.
	any	Whatever parameters are needed to be passed to the filter init function.

Source:

gameobjects/GameObjectFactory.js, line 369

Returns:

The newly created Phaser.Filter object.

Type: Phaser.Filter

graphics(x, y, group) → {Phaser.Graphics}

Creates a new Graphics object.

Parameters:

Name	Type	Argument	Description
`x`	number		X position of the new graphics object.
`y`	number		Y position of the new graphics object.
`group`	Phaser.Group	<optional>	Optional Group to add the object to. If not specified it will be added to the World group.

Source:

gameobjects/GameObjectFactory.js, line 226

Returns:

The newly created graphics object.

Type: Phaser.Graphics

group(parent, name, addToStage) → {Phaser.Group}

A Group is a container for display objects that allows for fast pooling, recycling and collision checks.

Parameters:

Name	Type	Argument	Default	Description
`parent`	any			The parent Group or DisplayObjectContainer that will hold this group, if any.
`name`	string	<optional>	'group'	A name for this Group. Not used internally but useful for debugging.
`addToStage`	boolean	<optional>	false	If set to true this Group will be added directly to the Game.Stage instead of Game.World.

Source:

gameobjects/GameObjectFactory.js, line 94

Returns:

The newly created group.

Type: Phaser.Group

image(x, y, key, frame, group) → {Phaser.Sprite}

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.

Parameters:

Name	Type	Argument	Description
`x`	number		X position of the image.
`y`	number		Y position of the image.
`key`	string \| Phaser.RenderTexture \| PIXI.Texture		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.
`frame`	string \| number	<optional>	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.
`group`	Phaser.Group	<optional>	Optional Group to add the object to. If not specified it will be added to the World group.

Source:

gameobjects/GameObjectFactory.js, line 42

Returns:

the newly created sprite object.

Type: Phaser.Sprite

renderTexture(width, height, key, addToCache) → {Phaser.RenderTexture}

A dynamic initially blank canvas to which images can be drawn.

Parameters:

Name	Type	Argument	Default	Description
`width`	number	<optional>	100	the width of the RenderTexture.
`height`	number	<optional>	100	the height of the RenderTexture.
`key`	string	<optional>	''	Asset key for the RenderTexture when stored in the Cache (see addToCache parameter).
`addToCache`	boolean	<optional>	false	Should this RenderTexture be added to the Game.Cache? If so you can retrieve it with Cache.getTexture(key)

Source:

gameobjects/GameObjectFactory.js, line 317

Returns:

The newly created RenderTexture object.

Type: Phaser.RenderTexture

sound(key, volume, loop, connect) → {Phaser.Sound}

Creates a new Sound object.

Parameters:

Name	Type	Argument	Default	Description
`key`	string			The Game.cache key of the sound that this object will use.
`volume`	number	<optional>	1	The volume at which the sound will be played.
`loop`	boolean	<optional>	false	Whether or not the sound will loop.
`connect`	boolean	<optional>	true	Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.

Source:

gameobjects/GameObjectFactory.js, line 146

Returns:

The newly created text object.

Type: Phaser.Sound

sprite(x, y, key, frame, group) → {Phaser.Sprite}

Create a new Sprite with specific position and sprite sheet key.

Parameters:

Name	Type	Argument	Description
`x`	number		X position of the new sprite.
`y`	number		Y position of the new sprite.
`key`	string \| Phaser.RenderTexture \| PIXI.Texture		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.
`frame`	string \| number	<optional>	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.
`group`	Phaser.Group	<optional>	Optional Group to add the object to. If not specified it will be added to the World group.

Source:

gameobjects/GameObjectFactory.js, line 62

Returns:

the newly created sprite object.

Type: Phaser.Sprite

spriteBatch(parent, name, addToStage) → {Phaser.Group}

A Group is a container for display objects that allows for fast pooling, recycling and collision checks.

Parameters:

Name	Type	Argument	Default	Description
`parent`	any			The parent Group or DisplayObjectContainer that will hold this group, if any.
`name`	string	<optional>	'group'	A name for this Group. Not used internally but useful for debugging.
`addToStage`	boolean	<optional>	false	If set to true this Group will be added directly to the Game.Stage instead of Game.World.

Source:

gameobjects/GameObjectFactory.js, line 112

Returns:

The newly created group.

Type: Phaser.Group

text(x, y, text, style, group) → {Phaser.Text}

Creates a new Text object.

Parameters:

Name	Type	Argument	Description
`x`	number		X position of the new text object.
`y`	number		Y position of the new text object.
`text`	string		The actual text that will be written.
`style`	object		The style object containing style attributes like font, font size , etc.
`group`	Phaser.Group	<optional>	Optional Group to add the object to. If not specified it will be added to the World group.

Source:

gameobjects/GameObjectFactory.js, line 183

Returns:

The newly created text object.

Type: Phaser.Text

tilemap(key, tilesets) → {Phaser.Tilemap}

Creates a new Tilemap object.

Parameters:

Name	Type	Description
`key`	string	Asset key for the JSON or CSV map data in the cache.
`tilesets`	object \| string	An object mapping Cache.tileset keys with the tileset names in the JSON file. If a string is provided that will be used.

Source:

gameobjects/GameObjectFactory.js, line 303

Returns:

The newly created tilemap object.

Type: Phaser.Tilemap

tileSprite(x, y, width, height, key, frame, group) → {Phaser.TileSprite}

Creates a new TileSprite object.

Parameters:

Name	Type	Argument	Description
`x`	number		The x coordinate (in world space) to position the TileSprite at.
`y`	number		The y coordinate (in world space) to position the TileSprite at.
`width`	number		The width of the TileSprite.
`height`	number		The height of the TileSprite.
`key`	string \| Phaser.RenderTexture \| Phaser.BitmapData \| PIXI.Texture		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.
`frame`	string \| number		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.
`group`	Phaser.Group	<optional>	Optional Group to add the object to. If not specified it will be added to the World group.

Source:

gameobjects/GameObjectFactory.js, line 162

Returns:

The newly created tileSprite object.

Type: Phaser.TileSprite

tween(obj) → {Phaser.Tween}

Create a tween object for a specific object. The object can be any JavaScript object or Phaser object such as Sprite.

Parameters:

Name	Type	Description
`obj`	object	Object the tween will be run on.

Source:

gameobjects/GameObjectFactory.js, line 81

Returns:

Description.

Type: Phaser.Tween