phaser
An Animation instance contains a single animation and the controls to play it.
An Animation instance contains a single animation and the controls to play it.
It is created by the AnimationManager, consists of Animation.Frame objects and belongs to a single Game Object such as a Sprite.
https://phaser.io/docs/2.6.2/Phaser.Animation.html
The Animation Manager is used to add, play and update Phaser Animations.
The Animation Manager is used to add, play and update Phaser Animations. Any Game Object such as Phaser.Sprite that supports animation contains a single AnimationManager instance.
https://phaser.io/docs/2.6.2/Phaser.AnimationManager.html
ArraySet is a Set data structure (items must be unique within the set) that also maintains order.
ArraySet is a Set data structure (items must be unique within the set) that also maintains order. This allows specific items to be easily added or removed from the Set.
Item equality (and uniqueness) is determined by the behavior of Array.indexOf.
This used primarily by the Input subsystem.
http://phaser.io/docs/2.6.2/Phaser.ArraySet.html
Audio Sprites are a combination of audio files and a JSON configuration.
Audio Sprites are a combination of audio files and a JSON configuration. The JSON follows the format of that created by https://github.com/tonistiigi/audiosprite.
BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.
BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure. It then generates a new Sprite object for each letter of the text, proportionally spaced out and aligned to match the font structure.
BitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability to use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by processing the font texture in an image editor, applying fills and any other effects required.
To create multi-line text insert \r, \n or \r\n escape codes into the text string.
If you are having performance issues due to the volume of sprites being rendered, and do not require the text to be constantly updating, you can use BitmapText.generateTexture to create a static texture from this BitmapText.
https://phaser.io/docs/2.6.2/Phaser.BitmapText.html
Create a new Bullet object.
Create a new Bullet object. Bullets are used by the Phaser.Weapon class, and are normal Sprites, with a few extra properties in the data object to handle Weapon specific features.
http://phaser.io/docs/2.6.2/Phaser.Bullet.html
Create a new Button object.
Create a new Button object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically.
The four states a Button responds to are:
'Over' - when the Pointer moves over the Button. This is also commonly known as 'hover'. 'Out' - when the Pointer that was previously over the Button moves out of it. 'Down' - when the Pointer is pressed down on the Button. I.e. touched on a touch enabled device or clicked with the mouse. 'Up' - when the Pointer that was pressed down on the Button is released again. A different texture/frame and activation sound can be specified for any of the states.
Frames can be specified as either an integer (the frame ID) or a string (the frame name); the same values that can be used with a Sprite constructor.
Phaser has one single cache in which it stores all assets.
Phaser has one single cache in which it stores all assets.
The cache is split up into sections, such as images, sounds, video, json, etc. All assets are stored using a unique string-based key as their identifier. Assets stored in different areas of the cache can have the same key, for example 'playerWalking' could be used as the key for both a sprite sheet and an audio file, because they are unique data types.
The cache is automatically populated by the Phaser.Loader. When you use the loader to pull in external assets such as images they are automatically placed into their respective cache. Most common Game Objects, such as Sprites and Videos automatically query the cache to extract the assets they need on instantiation.
You can access the cache from within a State via this.cache. From here you can call any public method it has, including adding new entries to it, deleting them or querying them.
Understand that almost without exception when you get an item from the cache it will return a reference to the item stored in the cache, not a copy of it. Therefore if you retrieve an item and then modify it, the original object in the cache will also be updated, even if you don't put it back into the cache again.
By default when you change State the cache is not cleared, although there is an option to clear it should your game require it. In a typical game set-up the cache is populated once after the main game has loaded and then used as an asset store.
https://phaser.io/docs/2.6.2/Phaser.Cache.html
Callbacks Object
Callbacks Object
A Camera is your view into the game world.
A Camera is your view into the game world. It has a position and size and renders only those objects within its field of view. The game automatically creates a single Stage sized camera on boot. Move the camera around the world with Phaser.Camera.x/y
The Canvas class handles everything related to creating the canvas DOM tag that Phaser will use, including styles, offset and aspect ratio.
The Canvas class handles everything related to creating the canvas DOM tag that Phaser will use, including styles, offset and aspect ratio.
http://phaser.io/docs/2.6.2/Phaser.Canvas.html
Creates a new Circle object with the center coordinate specified by the x and y parameters and the diameter specified by the diameter parameter.
Creates a new Circle object with the center coordinate specified by the x and y parameters and the diameter specified by the diameter parameter. If you call this function without parameters, a circle with x, y, diameter and radius properties set to 0 is created.
Phaser Create
Phaser Create
Phaser Cursor Keys
Phaser Cursor Keys
Settings used for debugging and diagnostics.
Settings used for debugging and diagnostics.
Created by ldaniels on 1/29/17.
Created by ldaniels on 1/29/17.
Created by ldaniels on 1/30/17.
Created by ldaniels on 1/30/17.
Phaser Easing
Phaser Easing
Creates a Ellipse object.
Creates a Ellipse object. A curve on a plane surrounding two focal points.
http://phaser.io/docs/2.6.2/Phaser.Ellipse.html
The Events component is a collection of events fired by the parent Game Object.
The Events component is a collection of events fired by the parent Game Object.
Phaser uses what are known as 'Signals' for all event handling. All of the events in this class are signals you can subscribe to, much in the same way you'd "listen" for an event.
For example to tell when a Sprite has been added to a new group, you can bind a function to the onAddedToGroup signal:
sprite.events.onAddedToGroup.add(yourFunction, this);
Where yourFunction is the function you want called when this event occurs.
For more details about how signals work please see the Phaser.Signal class.
The Input-related events will only be dispatched if the Sprite has had inputEnabled set to true and the Animation-related events only apply to game objects with animations like Phaser.Sprite.
http://phaser.io/docs/2.6.2/Phaser.Events.html
A Frame is a single frame of an animation and is part of a FrameData collection.
A Frame is a single frame of an animation and is part of a FrameData collection.
https://phaser.io/docs/2.6.2/Phaser.Frame.html
FrameData is a container for Frame objects, which are the internal representation of animation data in Phaser.
FrameData is a container for Frame objects, which are the internal representation of animation data in Phaser.
https://phaser.io/docs/2.6.2/Phaser.FrameData.html
This is where the magic happens.
This is where the magic happens. The Game object is the heart of your game, providing quick access to common functions and handling the boot process.
https://phaser.io/docs/2.6.2/Phaser.Game.html
Game Config Object
Game Config Object
The GameObjectCreator is a quick way to create common game objects without adding them to the game world.
The GameObjectCreator is a quick way to create common game objects without adding them to the game world.
The object creator can be accessed with game.make.
https://phaser.io/docs/2.6.2/Phaser.GameObjectCreator.html
A reference to the GameObjectFactory which can be used to add new objects to the World.
A reference to the GameObjectFactory which can be used to add new objects to the World.
Phaser: Game State
Phaser: Game State
2.6.2
The Gamepad class handles gamepad input and dispatches gamepad events.
The Gamepad class handles gamepad input and dispatches gamepad events.
Remember to call gamepad.start().
HTML5 GAMEPAD API SUPPORT IS AT AN EXPERIMENTAL STAGE! At moment of writing this (end of 2013) only Chrome supports parts of it out of the box. Firefox supports it via prefs flags (about:config, search gamepad). The browsers map the same controllers differently. This class has constants for Windows 7 Chrome mapping of XBOX 360 controller.
http://phaser.io/docs/2.6.2/Phaser.Gamepad.html
A Graphics object is a way to draw primitives to your game.
A Graphics object is a way to draw primitives to your game. Primitives include forms of geometry, such as Rectangles, Circles and Polygons. They also include lines, arcs and curves. When you initially create a Graphics object it will be empty. To 'draw' to it you first specify a lineStyle or fillStyle (or both), and then draw a shape.
http://phaser.io/docs/2.6.2/Phaser.Graphics.html
A Group is a container for display objects including Sprites and Images.
A Group is a container for display objects including Sprites and Images.
Groups form the logical tree structure of the display/scene graph where local transformations are applied to children. For instance, all children are also moved/rotated/scaled when the group is moved/rotated/scaled.
In addition, Groups provides support for fast pooling and object recycling.
Groups are also display objects and can be nested as children within other Groups.
http://phaser.io/docs/2.6.2/Phaser.Group.html
Group Extensions
An Image is a light-weight object you can use to display anything that doesn't need physics or animation.
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.
http://phaser.io/docs/2.6.2/Phaser.Image.html
Phaser.Input is the Input Manager for all types of Input across Phaser, including mouse, keyboard, touch and MSPointer.
Phaser.Input is the Input Manager for all types of Input across Phaser, including mouse, keyboard, touch and MSPointer. The Input manager is updated automatically by the core game loop.
http://phaser.io/docs/2.6.2/Phaser.Input.html
The Input Handler is bound to a specific Sprite and is responsible for managing all Input events on that Sprite.
The Input Handler is bound to a specific Sprite and is responsible for managing all Input events on that Sprite.
http://phaser.io/docs/2.6.2/Phaser.InputHandler.html
Creates a new Line object with a start and an end point.
Creates a new Line object with a start and an end point.
A collection of useful mathematical functions.
A collection of useful mathematical functions. These are normally accessed through game.math.
https://phaser.io/docs/2.6.2/Phaser.Math.html
The Physics Manager is responsible for looking after all of the running physics systems.
The Physics Manager is responsible for looking after all of the running physics systems. Phaser supports 4 physics systems: Arcade Physics, P2, Ninja Physics and Box2D via a commercial plugin.
Game Objects (such as Sprites) can only belong to 1 physics system, but you can have multiple systems active in a single game.
For example you could have P2 managing a polygon-built terrain landscape that an vehicle drives over, while it could be firing bullets that use the faster (due to being much simpler) Arcade Physics system.
http://phaser.io/docs/2.6.2/Phaser.Physics.html
Physics Configuration Options
Physics Configuration Options
https://github.com/photonstorm/phaser/blob/v2.6.2/src/physics/Physics.js
This is a base Plugin template to use for any Phaser plugin development.
This is a base Plugin template to use for any Phaser plugin development.
http://phaser.io/docs/2.6.2/Phaser.Plugin.html
The Plugin Manager is responsible for the loading, running and unloading of Phaser Plugins.
The Plugin Manager is responsible for the loading, running and unloading of Phaser Plugins.
http://phaser.io/docs/2.6.2/Phaser.PluginManager.html
A Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis.
A Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis. The following code creates a point at (0,0):
var myPoint = new Phaser.Point();
You can also use them as 2D Vectors and you'll find different vector related methods in this class.
A Pointer object is used by the Mouse, Touch and MSPoint managers and represents a single finger on the touch screen.
A Pointer object is used by the Mouse, Touch and MSPoint managers and represents a single finger on the touch screen.
http://phaser.io/docs/2.6.2/Phaser.Pointer.html
Enumeration categorizing operational modes of pointers.
Enumeration categorizing operational modes of pointers.
PointerType values represent valid bitmasks. For example, a value representing both Mouse and Touch devices can be expressed as PointerMode.CURSOR | PointerMode.CONTACT.
Values may be added for future mode categorizations.
A QuadTree implementation.
A QuadTree implementation. The original code was a conversion of the Java code posted to GameDevTuts. However I've tweaked it massively to add node indexing, removed lots of temp. var creation and significantly increased performance as a result.
2.6.2
http://phaser.io/docs/2.6.2/Phaser.QuadTree.html
Creates a new Rectangle object with the top-left corner specified by the x and y parameters and with the specified width and height parameters.
Creates a new Rectangle object with the top-left corner specified by the x and y parameters and with the specified width and height parameters. If you call this function without parameters, a Rectangle with x, y, width, and height properties set to 0 is created.
The Rounded Rectangle object is an area defined by its position and has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height.
The Rounded Rectangle object is an area defined by its position and has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height.
Create a new ScaleManager object - this is done automatically by Phaser.Game
Create a new ScaleManager object - this is done automatically by Phaser.Game
The width and height constructor parameters can either be a number which represents pixels or a string that represents a percentage: e.g. 800 (for 800 pixels) or "80%" for 80%.
https://phaser.io/docs/2.6.2/Phaser.ScaleManager.html
Created by ldaniels on 2/3/17.
Created by ldaniels on 2/3/17.
The Sound class constructor.
The Sound class constructor.
The Sound Manager is responsible for playing back audio via either the Legacy HTML Audio tag or via Web Audio if the browser supports it.
The Sound Manager is responsible for playing back audio via either the Legacy HTML Audio tag or via Web Audio if the browser supports it. Note: On Firefox 25+ on Linux if you have media.gstreamer disabled in about:config then it cannot play back mp3 or m4a files. The audio file type and the encoding of those files are extremely important. Not all browsers can play all audio formats. There is a good guide to what's supported here: http://hpr.dogphilosophy.net/test/
If you are reloading a Phaser Game on a page that never properly refreshes (such as in an AngularJS project) then you will quickly run out of AudioContext nodes. If this is the case create a global var called PhaserGlobal on the window object before creating the game. The active AudioContext will then be saved to window.PhaserGlobal.audioContext when the Phaser game is destroyed, and re-used when it starts again.
Mobile warning: There are some mobile devices (certain iPad 2 and iPad Mini revisions) that cannot play 48000 Hz audio. When they try to play the audio becomes extremely distorted and buzzes, eventually crashing the sound system. The solution is to use a lower encoding rate such as 44100 Hz. Sometimes the audio context will be created with a sampleRate of 48000. If this happens and audio distorts you should re-create the context.
Sprites are the lifeblood of your game, used for nearly everything visual.
Sprites are the lifeblood of your game, used for nearly everything visual. At its most basic a Sprite consists of a set of coordinates and a texture that is rendered to the canvas. They also contain additional properties allowing for physics motion (via Sprite.body), input handling (via Sprite.input), events (via Sprite.events), animation (via Sprite.animations), camera culling and more. Please see the Examples for use cases.
http://phaser.io/docs/2.6.2/Phaser.Sprite.html
Text Style Options
Text Style Options
Create a new game object for displaying Text.
Create a new game object for displaying Text.
This uses a local hidden Canvas object and renders the type into it. It then makes a texture from this for rendering to the view. Because of this you can only display fonts that are currently loaded and available to the browser: fonts must be pre-loaded.
Creates a new Phaser.Tilemap object.
Creates a new Phaser.Tilemap object. The map can either be populated with data from a Tiled JSON file or from a CSV file.
Tiled is a free software package specifically for creating tile maps, and is available from http://www.mapeditor.org
To do this pass the Cache key as the first parameter. When using Tiled data you need only provide the key. When using CSV data you must provide the key and the tileWidth and tileHeight parameters. If creating a blank tilemap to be populated later, you can either specify no parameters at all and then use Tilemap.create or pass the map and tile dimensions here.
Note that all Tilemaps use a base tile size to calculate dimensions from, but that a TilemapLayer may have its own unique tile size that overrides it.
A Tile map is rendered to the display using a TilemapLayer. It is not added to the display list directly itself. A map may have multiple layers. You can perform operations on the map data such as copying, pasting, filling and shuffling the tiles around.
http://phaser.io/docs/2.6.2/Phaser.Tilemap.html
A TilemapLayer is a Phaser.Image/Sprite that renders a specific TileLayer of a Tilemap.
A TilemapLayer is a Phaser.Image/Sprite that renders a specific TileLayer of a Tilemap.
Since a TilemapLayer is a Sprite it can be moved around the display, added to other groups or display objects, etc.
By default TilemapLayers have fixedToCamera set to true. Changing this will break Camera follow and scrolling behavior.
http://phaser.io/docs/2.6.2/Phaser.TilemapLayer.html
This is the core internal game clock.
This is the core internal game clock.
It manages the elapsed time and calculation of elapsed values, used for game object motion and tweens, and also handles the standard Timer pool.
To create a general timed event, use the master Phaser.Timer accessible through events.
A Timer is a way to create and manage timer events that wait for a specific duration and then run a callback.
A Timer is a way to create and manage timer events that wait for a specific duration and then run a callback. Many different timer events, with individual delays, can be added to the same Timer.
All Timer delays are in milliseconds (there are 1000 ms in 1 second); so a delay value of 250 represents a quarter of a second.
Timers are based on real life time, adjusted for game pause durations. That is, timer events are based on elapsed game time and do not take physics time or slow motion into account.
A TimerEvent is a single event that is processed by a Phaser.Timer.
A TimerEvent is a single event that is processed by a Phaser.Timer.
It consists of a delay, which is a value in milliseconds after which the event will fire. When the event fires it calls a specific callback with the specified arguments.
TimerEvents are removed by their parent timer once finished firing or repeating.
Use Phaser.Timer#add, Phaser.Timer#repeat, or Phaser.Timer#loop methods to create a new event.
A Video object that takes a previously loaded Video from the Phaser Cache and handles playback of it.
A Video object that takes a previously loaded Video from the Phaser Cache and handles playback of it.
Alternatively it takes a getUserMedia feed from an active webcam and streams the contents of that to the Video instead (see startMediaStream method)
The video can then be applied to a Sprite as a texture. If multiple Sprites share the same Video texture and playback changes (i.e. you pause the video, or seek to a new time) then this change will be seen across all Sprites simultaneously.
Due to a bug in IE11 you cannot play a video texture to a Sprite in WebGL. For IE11 force Canvas mode.
If you need each Sprite to be able to play a video fully independently then you will need one Video object per Sprite. Please understand the obvious performance implications of doing this, and the memory required to hold videos in RAM.
On some mobile browsers such as iOS Safari, you cannot play a video until the user has explicitly touched the screen. This works in the same way as audio unlocking. Phaser will handle the touch unlocking for you, however unlike with audio it's worth noting that every single Video needs to be touch unlocked, not just the first one. You can use the changeSource method to try and work around this limitation, but see the method help for details.
Small screen devices, especially iPod and iPhone will launch the video in its own native video player, outside of the Safari browser. There is no way to avoid this, it's a device imposed limitation.
Note: On iOS if you need to detect when the user presses the 'Done' button (before the video ends) then you need to add your own event listener
http://phaser.io/docs/2.6.2/Phaser.Video.html
The Weapon Plugin provides the ability to easily create a bullet pool and manager.
The Weapon Plugin provides the ability to easily create a bullet pool and manager.
Weapons fire Phaser.Bullet objects, which are essentially Sprites with a few extra properties. The Bullets are enabled for Arcade Physics. They do not currently work with P2 Physics.
The Bullets are created inside of Weapon.bullets, which is a Phaser.Group instance. Anything you can usually do with a Group, such as move it around the display list, iterate it, etc can be done to the bullets Group too.
Bullets can have textures and even animations. You can control the speed at which they are fired, the firing rate, the firing angle, and even set things like gravity for them.
A small example, assumed to be running from within a Phaser.State create method.
http://phaser.io/docs/2.6.2/Phaser.Weapon.html
A game has only one world.
A game has only one world. The world is an abstract place in which all game objects live. It is not bound by stage limits and can be any size. You look into the world via cameras. All game objects live within the world at world-based coordinates. By default a world is created the same size as your Stage.
Animation Singleton
Animation Singleton
Canvas Singleton
Canvas Singleton
CursorKeys Singleton
CursorKeys Singleton
Phaser Easing Singleton
Phaser Easing Singleton
Ellipse Singleton
Ellipse Singleton
Group Singleton
Group Singleton
Phaser Math Singleton
Phaser Math Singleton
phaser - A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers.
phaser - A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers.
2.6.2
Physics Singleton
Physics Singleton
Point Singleton
Point Singleton
Pointer Singleton
Pointer Singleton
Pointer Mode Singleton
Pointer Mode Singleton
Tilemap Singleton
Tilemap Singleton
Timer Singleton
Timer Singleton
Weapon Singleton
Weapon Singleton
phaser package object